Requests

REQUESTS

Esta api es la encargada de la creación de solicitudes que pueden ser esporádicas y fijas. Las solicitudes esporádicas se hacen en una fecha determinada y las fijas se generan en días fijos de las semana durante un periodo seleccionado de tiempo. A su vez, cada una de ellas pueden ser especiales (que se le puede asignar un precio) , estándar (que son las solicitudes "normales" con un precio estandarizado) y de Correos Frio. La api tambien tiene métodos de consulta que permite buscar información de las solicitudes ya sea mediante filtros o mediante un id y permite tambien modificar algunos datos de las solicitudes y sus estados.

Solicitud de acceso al 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.

Antes de que a una aplicación cliente se le permita consumir una API se debe solicitar acceso a la 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 (si estuviesen definidas).

Niveles de uso

Los APIS pueden tener definidos diferentes niveles de uso. Al solicitar acceso a un API verá indicaciones del nivel de uso (SLA) que ofrece el API. Tenga en cuenta que algunos niveles de uso pueden tener un coste asociado.

Políticas de seguridad

Existen varias políticas de seguridad que puede aplicarse a las APIS. Un API ofrecido por Correos puede llevar ninguna, una o varias de estas políticas.

En el caso de la API de requests, existen políticas de client credentials y validación JWT, por lo que para consumir los recursos es necesario enviar las credenciales y el token en la cabecera de la petición.

Client ID Enforcement

Política de aplicación de ID de cliente: El API espera unas cabeceras con pareja clave / valor en sus peticiones.

Antes de que a una aplicación cliente se le permita consumir una API protegida esta política, se debe solicitar acceso a la API. Después de que exista un contrato aprobado entre la aplicación cliente y la API, cada solicitud debe incluir las credenciales de la aplicación cliente de conformidad con la configuración de la política.

Las credenciales irán como cabeceras de la petición tal como muestra el siguiente ejemplo de petición usando curl:

curl "https://api1-intapp.correos.es/logistics/requests/api/v1/requests" -H "client_id:1234" -H "client_secret:abcd"

¿Es posible consultar client_id y client_secret si se me han olvidado o los he perdido?: Desde Exchange, o el portal de acceso a las APIs que se esté usando, puede consultar Mis Aplicaciones y ahí puede encontrar las credenciales de acceso.

Validación JWT

Política de seguridad capaz da validar tanto tokens JWT generados por OKTA como tokens generados por CorreosID (producto de seguridad de Correos).

Todas las llamadas al API deberán incluir el token JWT (Json Web Token) para poder usar el API.

Para realizar la llamada se deberá introducir la cabecera Authorization con el valor Bearer seguido del token.

curl "https://api1-intapp.correos.es/logistics/requests/api/v1/requests" -H "Authorization: Bearer {token}"

¿Cómo obtener el token JWT?: La obtención del token JWT será específico del sistema que lo proporciona (por ejemplo CorreosID) y deberá haber proporcionado documentación al respecto para hacer las llamadas a sus APIs para obtener un token válido. Por favor consulte con su contacto en Correos para obtener documentación relativa a CorreosID.