API Comex — EURUS PRO®
API REST de Comercio Exterior de EURUS PRO®. Permite consultar los documentos asociados a despachos de importación y exportación gestionados por una agencia EURUS PRO®.
Autenticación: todas las llamadas requieren enviar un API Key como
parámetro de query ?key=<API_KEY>. Este es el mecanismo que exige la
pasarela de API que publica el servicio.
Identificación: los endpoints bajo /dispatch/* y GET /files
requieren además el parámetro rut del cliente final
(ver Convenciones → RUT). Los de
/master/* no lo reciben: son catálogos de la agencia, no datos de un
cliente.
Antes de integrar: tres cosas que conviene saber
Las tres aplican a los endpoints de archivos
(GET /dispatch/{numeroDespacho}/files y GET /files), que son los que
devuelven documentos. Los demás declaran su propio
comportamiento en cada operación, y en al menos un punto es el contrario:
emiten las claves sin valor como null en vez de eliminarlas.
- La presencia de una clave no está garantizada. Antes de serializar,
la API elimina toda propiedad cuyo valor sea
null,undefinedo"". Un campo presente en un elemento puede faltar en el siguiente de la misma respuesta. Soloid,isActive,dispatcheinfoDocse emiten siempre.dispatches la excepción a la regla: trae todas sus claves, con""onullcuando no hay dato. infoDocsiempre existe, pero puede venir vacío, y un objeto vacío es truthy en JavaScript. Verifica contenido (item.infoDoc?.document?.number), no presencia (item.infoDoc).- La
urlde descarga caduca en 1 hora. No la almacenes más allá de ese plazo: vuelve a consultar el endpoint.
Las tres están explicadas en detalle en Convenciones.
Authentication
- API Key: ApiKeyQuery
API Key provista por EURUS PRO®. Debe enviarse como query parameter
en todas las llamadas (?key=<API_KEY>), siguiendo el mecanismo de
la pasarela de API.
Security Scheme Type: | apiKey |
|---|---|
Query parameter name: | key |
License
Propietaria