boxentry

API para el preregistro de paquetes o pallets en el sistema de Correos.
Se proporciona una interfaz adecuada al formato único de Correos, de forma que la integración con las distintas aplicaciones de Correos para este preregistro puedan realizarse de forma ágil y ajustándonos a los estándares establecidos por Correos. Este API ha sido diseñado con el objetivo de establecer un método de preregistro de cajas único que sirva para cada cliente que quiera hacer uso de esta funcionalidad.

Las distintas operaciones existentes en este API son:

• Creación de pedidos
• Modificación de pedidos
• Eliminación de pedidos

Características del API

• Políticas de seguridad requeridas:
  • Client ID Enforcement
• Información de soporte:
  • Consultas generales: mantenimiento.DI@correos.com

Nota: En esta documentación se incluyen ejemplos ilustrativos usando curl. Esto no significa que esté obligado a usar curl, para utilizar el API puede emplear cualquier programa que permita realizar peticiones HTTP.

Sobre las políticas de seguridad requeridas

Antes de poder usar el API lo primero será conseguir las credenciales de acceso necesarias para cumplir con las políticas de seguridad requeridas.

Client ID Enforcement

El API espera unas cabeceras con pareja clave/valor en sus peticiones. Todas las llamadas al API deberán incluir estos datos.

Antes de que a una aplicación cliente se le permita consumir una API protegida con esta política se debe solicitar acceso a la API.

Desde el propio Exchange, o el portal de acceso a las APIs que se esté usando, existirá una opción de Solicitar acceso. Si no ve esa opción quiere decir que esa API no admite solicitudes de acceso y deberá ponerse en contacto con el equipo de soporte del API.

Una vez solicitado el acceso, la petición pasa por un flujo de aprobación. Una vez finalizado ese flujo, y aprobado por el propietario del API, recibirá un email con las credenciales de acceso.

Las credenciales se adjuntarán como cabeceras de todas las invocaciones al API tal como muestra el siguiente ejemplo usando curl:

curl --location 'https://api1.correos.es/<organization-name>/<api-name>/api/v1/myResource' \
--header 'client_id: 123456' \
--header 'client_secret: my_secret'

Guía de uso

Tengan en cuenta que este API está disponible tanto para RI como DMZ, pero los mismos credenciales client id/client secret no funcionarán para ambas versiones a no ser que así se hayan pedido.

Además, sepan que este API se trata de una pasarela que envía los datos recibidos a la aplicación de destino correspondiente sin realizar cambios sobre ellos. Sin embargo, existe una pequeña modificación a la hora de llamar a este API que hay que tener en cuenta: todos los cuerpos de las peticiones deberán ir en texto plano. Este API se encargará de enviarlos en formato JSON a la aplicación de destino.