DeCAfacil API - Consola de pruebas

Consola de pruebas

Las llamadas se hacen contra la API real. Use una clave de pruebas para ensayar altas o modificaciones.

Abrir documentación y pruebas en Swagger

X-Api-Key Operación Ejemplo de integración

Id interno

Limit

Campo de fecha

No planificados

Texto de búsqueda

Estado del maestro

Fecha desde

Fecha hasta

Las fechas son opcionales. Puede indicar solo desde, solo hasta, ambas o ninguna.

Origen registro

Id externo

JSON para POST

Abrir Swagger UI

Preparado.

Respuesta

{}

Resumen para integradores

La clave viaja siempre en cabecera HTTP: X-Api-Key: tu_clave. No se admite por URL ni en el cuerpo.

Esta consola simplifica las pruebas más habituales. Para consultar todos los esquemas, ejemplos y respuestas, utilice el Swagger UI oficial.

Endpoints disponibles para documentos y maestros: crear actualizar consultar listar buscar clientes vehículos conductores

Uso	Metodo	Parametros clave
Crear	POST JSON	`accion=crear`, datos del viaje, `lineas[]`
Actualizar	POST JSON	`accion=actualizar`, `id`, campos a cambiar
Consultar	GET	`accion=consultar&id=12`
Listar	GET	`fechaCampo`, `fechaDesde`, `fechaHasta`, `noPlanificados=1`
Buscar	GET	`accion=buscar&origen=ERP_CLIENTE&idExterno=12345`
Sincronizar maestro	POST JSON	`accion=guardar` y referencia `origenRegistro + idExterno`
Consultar maestro	GET	`id`, referencia ERP, `q`, `activo`, `limit` y `offset`

Los maestros son opcionales. Puede sincronizar clientes, vehículos y conductores para compartirlos con la aplicación web, o enviar directamente en cada DeCA la fotografía contractual del viaje: cargadorNombre, cargadorNif, cargadorDomicilio, matriculaTractora, matriculaRemolque y las lineas de mercancia. El enlace con el ERP se conserva con origenRegistro e idExterno.