El Módulo API permite exponer la información de Zynara mediante llamadas HTTP, facilitando la integración con aplicaciones y servicios de terceros para la consulta y procesamiento de datos en tiempo real.
Configuración del servidor
Zynara actúa como servidor HTTP a través del Módulo Servidor APP.
- Acceda a Archivo → Preferencias → Módulos
- Localice Servidor APP y haga clic en Configurar
- Active el Servidor APP.
Parámetros:
- Puerto: por defecto
1994 - Clave de autorización: no se utiliza en la API, puede dejarse con el valor predeterminado
Una vez activado:
- El servidor estará disponible mientras Zynara esté en ejecución
- Acceso en red local:
http://<ip_local>:1994 - Acceso externo:
http://<ip_publica>:1994
(requiere redirección de puerto en el router)
Configuración de la API
Tras habilitar el servidor HTTP, debe activarse el Módulo API Rest:
- Acceda a Archivo → Preferencias → Módulos
- Localice API Rest y haga clic en Configurar
Parámetros:
- apiKey: se genera automáticamente y puede regenerarse en cualquier momento
- Es obligatoria en todas las peticiones
- Se utiliza para autenticación
Configuración de acceso a datos:
- Seleccione las tablas que desea exponer
- Configure, mediante el icono correspondiente, las columnas visibles para cada tabla
Uso
Una vez habilitados:
- Servidor APP
- API Rest
El sistema estará preparado para recibir llamadas HTTP a la API.
Parámetros GET
Los parámetros se incluyen en la URL. Son obligatorios dos: apikey para la autorización y t para indicar la tabla a consultar. El resto de parámetros pueden ser obligatorios dependiendo de la tabla.
Ejemplo de uso: http://192.168.1.12:1994/?apikey=<apikey>&t=<tabla>
La IP especificada debe corresponder a un Servidor ejecutando el módulo Servidor APP de Zynara.
| Parámetro | Descripción | Ejemplo |
|---|---|---|
| apikey | Clave API de autorización. Obligatorio. | |
| t | Código de la tabla a consultar. Ver cuadro inferior. Obligatorio. | t=act Lista completa de las actividades. |
| c | Mostrar únicamente el código indicado. Puede ser un texto o número, según la tabla. Solo devuelve un registro. Opcional. | t=cli&c=100 Devuelve el cliente 100. t=conceptos&c=gasoil Devuelve el concepto con código gasoil |
| canal | Muestra únicamente los registros con el canal indicado. Solo aplicable a tablas con canal y uso obligatorio en ellas. | t=av&canal=F Muestra todos los albaranes de venta del canal F. |
| d , h | Limita la salida a los códigos comprendidos entre el desde y hasta. Opcional. | t=cli&d=10&h=20 Muestra todos los clientes entre el código 10 y 20. |
| df , hf | Limita la salida a las fechas comprendidas entre el desde y hasta. Solo aplicable a tablas con fechas. En formato DDMMAAAA. Opcional, salvo en tabla de Llamadas. | t=fv&canal=F&df=01122025&hf=31122025 Muestra todas las facturas de venta del canal F comprendidas entre el 1 y 31 de diciembre de 2025. |
Parámetro que indica la tabla: t
El parámetro t indica la tabla a consultar. Se indica el código correspondiente a cada tabla, los parámetros que soporta y el número máximo de filas devueltas. Las tablas que pueden contener un número elevado de registros son limitadas en su salida para evitar sobrecarga. Si su consulta abarca más de 1000 registros en algunas tablas, deberá acotar el resultado por códigos o fechas.
| Tabla | Parámetro t | Parámetros adicionales | Máximas filas devueltas |
|---|---|---|---|
| Actividades | act | c, d, h | Ilimitadas |
| Rutas, Transportistas | rutas | c, d, h | Ilimitadas |
| Conceptos | conceptos | c, d, h | Ilimitadas |
| Artículos | art | c, d, h | 1000 |
| Proveedores | pro | c, d, h | 1000 |
| Clientes | cli | c, d, h | 1000 |
| Contactos | con | c, d, h | 1000 |
| Representantes | rep | c, d, h | Ilimitadas |
| Albaranes de Venta | av | c, d, h, canal, df, hf c se aplica al número de albarán. df, hf se aplica a la fecha albarán. | 1000 |
| Partidas de albaranes de venta | pav | c, d, h, canal, df, hf c se aplica al número de albarán. df, hf se aplica a la fecha albarán. | 1000 |
| Albaranes de Compra | ac | c, d, h, canal, df, hf c se aplica al número de albarán. df , hf se aplica a la fecha albarán. | 1000 |
| Partidas de albaranes de compra | pac | c, d, h, canal, df, hf c se aplica al número de albarán. df , hf se aplica a la fecha albarán. | 1000 |
| Pedidos de Venta | pv | c, d, h, canal, df, hf c se aplica al número de pedido. df , hf se aplica a la fecha pedido. | 1000 |
| Partidas de pedidos de venta | ppv | c, d, h, canal, df, hf c se aplica al número de pedido. df , hf se aplica a la fecha pedido. | 1000 |
| Pedidos de Compra | pc | c, d, h, canal, df, hf c se aplica al número de pedido. df /hf se aplica a la fecha pedido | 1000 |
| Partidas de pedidos de compra | ppc | c, d, h, canal, df, hf c se aplica al número de pedido. df /hf se aplica a la fecha pedido | 1000 |
| Presupuestos Clientes (Ventas) | prv | c, d, h, canal, df, hf c se aplica al número de presupuesto. df , hf se aplica a la fecha presupuesto. | 1000 |
| Partidas de presupuestos de clientes | pprv | c, d, h, canal, df, hf c se aplica al número de presupuesto. df , hf se aplica a la fecha presupuesto. | 1000 |
| Presupuestos Proveedores (Compras) | prc | c, d, h, canal, df, hf c se aplica al número de presupuesto. df, hf se aplica a la fecha presupuesto. | 1000 |
| Partidas de presupuestos de proveedores | pprc | c, d, h, canal, df, hf c se aplica al número de presupuesto. df , hf se aplica a la fecha presupuesto. | 1000 |
| Facturas de Venta | fv | c, d, h, canal, df, hf c se aplica al número de factura. df, hf se aplica a la fecha factura. | 1000 |
| Facturas de Compra | fc | c, d, h, canal, df, hf c se aplica al número de factura. df , hf se aplica a la fecha factura. | 1000 |
| Gastos (tickets) | gastos | c, d, h, canal, df, hf c se aplica al código de proveedor. df , hf se aplica a la fecha del gasto. | 1000 |
| Gastos (directos) | directos | df, hf df, hf se aplica a la fecha del gasto. | 1000 |
| Remesas de clientes | remv | c, d, h, df, hf c se aplica al código de remesa. df , hf se aplica a la fecha de presentación. | 1000 |
| Remesas de proveedores | remc | c, d, h, df, hf c se aplica al código de remesa. df , hf se aplica a la fecha de presentación. | 1000 |
| Fabricantes | fab | c, d, h | Ilimitadas |
| Familias | fam | c, d, h | Ilimitadas |
| Zonas | zon | c, d, h | Ilimitadas |
| Calendarios | cal | c, d, h | Ilimitadas |
| Motivos de Rectificación | mot | c, d, h | Ilimitadas |
| Conductores, Operarios | cond | c, d, h | Ilimitadas |
| Bancos | bancos | c, d, h | Ilimitadas |
| Idiomas | idiomas | c, d, h | Ilimitadas |
| Textos predefinidos | txt | c, d, h | Ilimitadas |
| Hojas de cálculo | hojas | c, d, h | Ilimitadas |
| Municipios | mun | c, d, h c se aplica al código postal | 2000 |
| Tarifas específicas de clientes | tarcli | c, d, h c se aplica al código de cliente | 1000 |
| Tarifas específicas de proveedores | tarpro | c, d, h c se aplica al código de proveedor | 1000 |
| Vehículos | veh | c, d, h c se aplica a la matrícula del vehículo | Ilimitadas |
| Conjuntos de vehículos | conjuntos | c, d, h | Ilimitadas |
| Partes de vehículos | partes | c, d, h, df, hf c se aplica al código de conductor. df , hf se aplica a la fecha del parte. | 1000 |
| Mantenimientos | mant | c, d, h, df, hf c se aplica a la matrícula del vehículo. df , hf se aplica a la fecha del mantenimiento. | 1000 |
| Recibos de venta | rv | c, d, h, canal, df, hf c se aplica al número de factura. df , hf se aplica a la fecha vencimiento. | 1000 |
| Recibos de compra | rc | c, d, h, canal, df, hf c se aplica al número de factura. df , hf se aplica a la fecha vencimiento. | 1000 |
| Cobros | cobros | c, d, h, canal, df, hf c se aplica al número de factura. df , hf se aplica a la fecha del cobro. | 1000 |
| Pagos | pagos | c, d, h, canal, df, hf c se aplica al número de factura. df, hf se aplica a la fecha del pago. | 1000 |
| Régimen de IVA | reg | c, d, h | Ilimitadas |
| Tipos de Pago | tipos | c, d, h | Ilimitadas |
| Direcciones | dirs | c, d, h c se aplica al código de cliente | 1000 |
| Movimientos de Almacén | stock | c, d, h, canal, df, hf c se aplica al código de artículo. df, hf se aplica a la fecha del movimiento. | 1000 |
| Códigos de Barras | bar | c, d, h c se aplica al código de artículo | 1000 |
| Descuentos por famílias | dtofam | c, d, h c se aplica al código de familia | Ilimitadas |
| Proyectos | proy | c, d, h, canal, df, hf c se aplica al código de proyecto. df, hf se aplica a la fecha de alta del proyecto. | Ilimitadas |
| Códigos CER/LER | cer | c, d, h | Ilimitadas |
| Órdenes de Fabricación | of | c, d, h, df, hf c se aplica al código de orden. df, hf se aplica a la fecha de alta de la orden. | 1000 |
| Canales | can | c, d, h | Ilimitadas |
| Llamadas | call | df, hf df, hf se aplica a la fecha de la llamada. | 1000 |
| Contratos | contratos | c, d, h, df, hf c se aplica al código de cliente. df, hf se aplica a la fecha de alta del contrato. | 1000 |
| RAE | rae | c, d, h | Ilimitadas |
| Máquinas | maq | c, d, h | Ilimitadas |
| Almacén | almacen | c, d, h | Ilimitadas |
| Cajas (TPV) | cajas | c, d, h | Ilimitadas |
| Arqueo (TPV) | arqueo | df, hf df, hf se aplica a la fecha del arqueo. | 1000 |
| Vales (TPV) | vales | df, hf df, hf se aplica a la fecha del vale. | 1000 |
| Usuarios | users | c, d, h | Ilimitadas |
| Categorías de clientes y proveedores | cat1 | c, d, h | Ilimitadas |
| Categorías de artículos | cat2 | c, d, h | Ilimitadas |
| Categorías de documentos | cat3 | c, d, h | Ilimitadas |
Test de Conexión
El parámetro t=test realiza un Test de conexión.
Si es correcto, devuelve el código 200 y una descripción donde incluye el nombre de la empresa.
Ejemplo de salida para http://localhost/?apikey=<apikey>&t=test
{"Codigo":200,"Mensaje":"Test correcto. Empresa TEST VERI*FACTUR"}
Versiones
El parámetro t=zynara notifica la versión de la aplicación.
Ejemplo de salida para http://localhost/?apikey=<apikey>&t=zynara
{"Codigo":200,"Mensaje":"1.75.11 (TEST VERI*FACTUR)"}
Para saber la versión de la API, envíe el parámetro t=api.
Ejemplo de salida para http://localhost/?apikey=<apikey>&t=zynara
{«Codigo»:200,»Mensaje»:»1,1″}
Errores HTTP
Cuando el Servidor APP de Zynara no puede procesar los datos, devuelve una estructura JSON con código de error 500 y una descripción asociada.
500 – Apikey no válida. La clave de autorización no ha sido definida o no es válida.
500 – No se ha especificado la tabla. El parámetro «t» no se ha definido.
500 – Tabla no válida. El parámetro «t» hace una referencia a una tabla que no existe. Revise el cuadro anterior.
500 – Tabla no autorizada para su uso API. Se ha definido una tabla en el parámetro «t» que no ha sido incluida en la salida API. Revise la configuración en el Módulo API.
500 – No se ha especificado ninguna columna de salida. No se han definido columnas para mostrar en la tabla del parámetro «t». Revise la configuración en el Módulo API.
500 – No se ha especificado el código desde. Se ha definido el parámetro «h» pero se ha omitido el «d».
500 – No se ha especificado el código hasta. Se ha definido el parámetro «d» pero se ha omitido el «h».
500 – No se ha especificado la fecha desde. Se ha definido el parámetro «hf» pero se ha omitido el «df».
500 – No se ha especificado la fecha hasta. Se ha definido el parámetro «df» pero se ha omitido el «hf».
500 – No se ha especificado el canal. La tabla requiere el parámetro «canal» y no ha sido definido.
500 – No se ha especificado la fecha. La tabla requiere los parámetros «df» y «hf» y no han sido definidos.
500 – Fechas no válidas. Las fechas desde/hasta especificadas no cumplen la sintaxis DDMMAAAA.
500 – Parámetros no válidos. Se han enviado parámetros no permitidos para la tabla.
404 – Sin datos No hay datos para mostrar.