telegraphs

TELEGRAPHS

El api se encarga de la gestion de los distintos productos telegráficos recogiendo y enviando la información procedente de la aplicación de OV2.

• Descripción general
  • Características del API
  • Sobre las políticas de seguridad requeridas
  • Niveles de uso
• Guía de uso
• Descripción de implementación

DESCRIPCION GENERAL

La interfaz se comunica con OV2 para gestionar lo diferentes productos telegráficos.

Características del API

• Políticas de seguridad requeridas:
  • Client ID Enforcement
• Niveles de uso:
  • Max. 1000 llamadas-hora (aprobación previa)
  • Max. 200 llamadas-día (acceso libre)
• Información de soporte:
  • Consultas generales: mantenimiento.neo@correos.com

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.

Cabecera Valor
client_id Suministrado una vez solicitado el acceso al API
client_secret Suministrado una vez solicitado el acceso al API

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/admissions/telegraphs/api/v1/myResource' \
--header 'client_id: 123456' \
--header 'client_secret: my_secret'

Dudas frecuentes
¿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.

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

Max. 1.000 llamadas-hora (aprobación previa)
​Se podrá realizar no menos de 1.000 invocaciones totales a un API en una misma hora (independiente del origen de invocación). A partir de ese momento el API dejará de dar servicio hasta la próxima hora.

Max. 200 llamadas-día (acceso libre)
​Se podrá realizar no menos de 200 invocaciones diarias totales a un API en una misma hora (independiente del origen de invocación). A partir de ese momento el API dejará de dar servicio hasta el siguiente día.​Este uso del API es gratuito y se incluye para demostraciones.