citypaqusers

CITYPAQUSERS

This API allows the consultation of information about users whose actions are performed in citypaq. It allows queries such as: consult if a user is migrated to CorreosID, consult the citypaq's that are favourites for a user given its correoID identification code. It also allows to perform actions on the information of users whose information appears in citypaq. It allows actions such as: login in citypaq given its user and password, associate a user's citypaq account with the user's correosID account, notify the unsubscription of a user to ctiypaq, notify the user's data that has been modified in correosID, create a user in Citypaq given its correosID data, modify the alias or the citypaq default index for a client's favorite Citypaq, delete a client's favorite citypaq and associate a citypaq as favorite for a user given the oid. A valid client id and client secret as well as a valid citypaq basic authorization must be included in all resources.

• Aspectos generales de las APIs de Correos
  • Solicitud de acceso al API
  • Niveles de uso
  • Políticas de seguridad
  • Introducción uso de API REST

Aspectos generales de las APIs de Correos

Nota: Cualquier cliente que pueda realizar peticiones HTTP serviría.

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.

Para conocer los niveles de uso que aplican a su API puede revisar la Descripción general del API

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.

Para conocer las políticas de seguridad que aplican a su API puede revisar la Descripción general del API

Sin política de seguridad

Un API puede haber sido definido para que no requiera autorización (APIs de uso interno o de uso abierto) por lo que no hay necesidade de incluir ningún aspecto adicional en las llamadas al API.

curl "http://example.restapi.es/myResource"

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 "http://example.restapi.es/myResource" -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 ISAM 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 "http://example.restapi.es/myResource" -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.

Introducción uso de API REST

REST APIs utilizan Uniform Resource Identifiers (URI) para direccionar los recursos. Los diseños de URIs bien hechos comunicarían claramente el recurso de la API, como por ejemplo:

http://example.restapi.es/france/paris/louvre/leonardo-da-vinci/mona-lisa

Un diseño incorrecto de los URIs daría un recurso mucho más difícil de entender como:

http://example.restapi.es/68dd0-a9d3-11e0-9f1c-0800200c9a66

Formato de URI

La sintaxis del URI genérico se define como sigue:

URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]

• scheme: El esquema identifica el protocolo de acceso a los recursos (http, https)
• authority: Es el elemento jerárquico que identifica la autoridad de nomenclatura, está formado por el nombre de host y el puerto.
• path: La ruta es la parte más específica del URI que indica la ruta o ubicación del recurso dentro del servidor. El camino puede incluir jerarquías profundas y a menudo refleja la estructura organizativa de los recursos..
• query: Es un componente opcional que se incluye después de la ruta de acceso y tiene una estructura no jerárquica, y proporciona una cadena de información que el recurso puede utilizar para algún propósito, por ejemplo, para buscar parámetros o datos a procesar. La consulta suele ser una cadena de pares de parámetros y valores ("argumento=valor"). Los argumentos junto con los valores se separan entre sí con un ampersand ("&").
• fragment: El fragmento es un componente opcional que permite identificar una parte del recurso principal, o la vista de una representación del mismo. El comienzo de este componente se indica con el carácter de libra ("#").