Integración

Catálogo de recursos

La API publica alrededor de 130 recursos. Esta página los agrupa por familias para que encuentres el que necesitas sin recorrer la lista entera.

La lista exacta de lo publicado en tu solución se obtiene con GET {BASE}/layouts, y los campos de cada uno con GET {BASE}/layouts/{recurso}.

Qué publica un recurso y qué no

Cada recurso expone un juego concreto de campos, elegido para su uso. Dos recursos sobre la misma información pueden mostrar cosas distintas: es deliberado, y por eso conviene mirar los campos antes de decidir con cuál trabajar.

Cuatro variantes que verás repetidas#

Antes del catálogo, un patrón que se repite y que ahorra mucho tráfico:

Sufijo	Para qué sirve
`_IDS`	Devuelve solo el identificador. Ideal para saber qué hay sin descargar nada más: se comparan listas y solo se piden al detalle los que han cambiado
`_GRID`	Un juego reducido de campos, el de un listado. Para pintar tablas sin traer la ficha completa
`_IMAGEN`	La imagen separada del recurso principal, para que consultar la ficha no la arrastre
`_FORMATOS`	Los formatos de impresión asociados al documento

El patrón que hace rápida una sincronización

Pide _IDS, compara con lo que ya tienes, y descarga al detalle solo las diferencias. Es la diferencia entre sincronizar en segundos o en minutos.

Maestros#

Recurso	Contiene
`API_CLIENTES`	Clientes, con sus datos fiscales y comerciales
`API_CONTACTOS`	Personas de contacto de cada cliente
`API_DIRECCIONES`	Direcciones de entrega y de servicio
`API_ARTICULOS`	Artículos, con precios de venta y compra
`API_CODIGOS_BARRAS`	Códigos de barras de los artículos
`API_KIT`	Composición de artículos tipo kit
`API_PERSONAS`	Quién hace el trabajo
`API_ACTIVOS`	Los equipos e instalaciones del cliente
`API_MANTENIMIENTOS`	Los mantenimientos previstos de cada activo
`API_ALMACENES`	Almacenes
`API_PAISES`, `API_PROVINCIAS`	Geografía

Trabajo#

Recurso	Contiene
`API_PROYECTOS`	Proyectos y contratos
`API_PROYECTOS_PERSONAL`, `API_PROYECTOS_RECURSOS`	Su equipo y sus medios
`API_TAREAS`	Las tareas, el trabajo concreto
`API_TAREAS_PERSONAL`, `API_TAREAS_RECURSOS`	Quién y con qué
`API_TAREAS_ACTIVOS`	Sobre qué equipos se actúa
`API_TAREAS_MANTENIMIENTOS_ACTIVOS`	Los mantenimientos cubiertos por la tarea
`API_PLANIFICACIONES_TAREA`	Cuándo está previsto hacer cada cosa
`API_PARTES`	Los partes de trabajo
`API_SERVICIOS_PARTE`	Las horas de cada parte
`API_MATERIALES_PARTE`	El material consumido
`API_GASTOS_PARTE`, `API_GASTOS_PARTE_RECIBO`	Gastos y sus recibos
`API_CHECKLIST_DEFINICION`, `API_CHECKLIST_PARTES`	Listas de comprobación y su resultado

El parte es el documento que sostiene la facturación

Si vas a integrar una sola cosa, integra los partes con sus servicios y materiales: es lo que convierte trabajo en importe.

Documentos de venta#

Recurso	Contiene
`API_PRESUPUESTOS_ALBARANES`	Presupuestos y albaranes, que comparten estructura
`API_DETALLES_PRESUPUESTO`, `API_DETALLES_PRESUPUESTO_LINEAS`	Sus líneas
`API_CONCEPTOS_FACTURABLES`	Lo facturable de un trabajo
`API_CONCEPTOS_INCLUIDOS`	Lo que va incluido y no se factura aparte
`API_CUOTAS`	Las cuotas de facturación periódica
`API_FACTURACION_PERIODICA`	La configuración de esa periodicidad
`API_PRESUPUESTO_ESTANDAR`, `API_PARTE_ESTANDAR`	Plantillas de líneas para crear documentos

Presupuesto y albarán son el mismo documento en dos momentos

Comparten recurso, y se distinguen por su tipo de documento. Al filtrar, indícalo o recibirás los dos.

Catálogos#

Las listas con las que se clasifica todo lo demás. Todas siguen el mismo patrón: identificador, código, descripción, orden y vigencia.

Recurso	Catálogo
`API_ESTADOS`	Estados de proyectos, tareas, partes y presupuestos
`API_TIPOS_PROYECTO`, `API_TIPOS_TAREA`, `API_TIPOS_PARTE`	Clasificación del trabajo
`API_TIPOS_ACTIVO`	Clasificación de los equipos
`API_TIPOS_HORA`, `API_PERFILES_TIPO_HORA`	Tipos de hora y su relación con los perfiles
`API_TIPOS_TRABAJO`	Clasificación del trabajo realizado
`API_TIPOS_IVA`	Impuestos
`API_TARIFAS`	Tarifas de precios
`API_SERIES`, `API_ACTIVIDADES`	Series y actividades, que forman los códigos de documento
`API_ZONAS`, `API_RUTAS`	Organización geográfica
`API_DEPARTAMENTOS`, `API_CARGOS`, `API_CATEGORIAS_PERSONAL`	Organización de personas
`API_FORMAS_PAGO`, `API_DOCUMENTOS_PAGO`	Cómo y con qué se cobra
`API_HORARIOS`	Horarios laborales
`API_PERIODOS_RENOVACION`	Periodicidad de renovación de contratos
`API_PRIORIDADES`	Prioridad de las tareas
`API_ETIQUETAS`	Etiquetas de color

Calidad#

Disponible si tienes contratado ese módulo.

Recurso	Contiene
`API_INCIDENCIAS`	Incidencias y no conformidades
`API_TIPOS_INCIDENCIA`, `API_TIPOS_IMPACTO`	Su clasificación

Documentación e imágenes#

Recurso	Contiene
`API_DOCUMENTACION`	Los ficheros asociados a cada registro
`API_DOCUMENTACION_IMAGEN`	Su contenido gráfico
`API_ARTICULOS_IMAGEN`, `API_CLIENTES_IMAGEN`, `API_PERSONAS_IMAGEN`	Las imágenes de cada ficha

Configuración y seguridad#

Recurso	Contiene
`API_EMPRESAS`	Las empresas de tu solución. Aquí se obtiene el identificador que hay que usar como filtro
`API_USUARIOS`	Cuentas de acceso
`API_PERFILES`, `API_SEGURIDAD`	Perfiles de equipo y sus permisos
`API_CAMPOS_ADICIONALES`, `API_DATOS_CAMPOS_ADICIONALES`	Los campos propios definidos por la empresa y sus valores
`API_SYS`, `API_SYS_CONFIGURACION_MOVIL`	Parámetros de la solución y de la movilidad
`API_LOG_ERRORES`	Registro de errores de la aplicación móvil

Empieza siempre por API_EMPRESAS

Es la primera llamada de cualquier integración: sin el identificador de la empresa, el resto de consultas no se pueden filtrar bien.

Analítica#

API_BI_CLIENTES, API_BI_ARTICULOS y API_BI_PRESUPUESTOS son juegos reducidos pensados para alimentar cuadros de mando. Para volúmenes grandes, mira también Analítica y BI.

Campos que se repiten en casi todos#

Campo	Qué es
`ID`	El identificador estable. El que debes guardar
`ID_EMPRESA`	A qué empresa pertenece
`CODIGO`	El código visible para el usuario
`DESCRIPCION` o `NOMBRE`	El texto que se lee
`VIGENTE`	1 si está en uso, 0 si se ha retirado
`CREADOEL`, `MODIFICADOEL`	Cuándo se creó y se modificó por última vez

MODIFICADOEL es tu amigo para sincronizar

Filtrando por MODIFICADOEL mayor que la última sincronización, te traes solo lo que ha cambiado. Recuerda el formato de fecha: mes/día/año.

Qué viene después#

Errores y límites y, para lectura masiva, Analítica y BI.