preregcain

API ad hoc del cliente CAINIAO para la realización de los distintos preregistros en los sistemas de Correos. Este API transforma la petición del cliente al formato adecuado en Correos y lo envía para su procesamiento interno, este comportamiento es asíncrono por lo que no se espera por la respuesta de ninguna otra aplicación, la respuesta del API solo nos informará de si ha podido enviarse el mensaje con éxito o no.

Al tratarse de un API diseñado exclusivamente para CAINIAO se ha adaptado la definición de la interfaz de entrada y salida a su estructura y tipología de datos.

Los distintas operaciones existentes en este API son:

• Preregistro de paquetes o pallets
• Preregistro de envíos
• Preregistro de envíos con logística inversa
• Actualización aduanera de preregistro de envíos
• Cancelación de envíos preregistrados

Política de seguridad:

Esta API tiene la política de seguridad denominada "Client ID Enforcement", https://docs.mulesoft.com/api-manager/2.x/client-id-based-policies. Primero, la aplicación cliente debe solicitar acceso a esta API, luego se proporcionarán un par de client_id y client_secret. Una vez que los propietarios de la API acepten la solicitud, se otorgará al cliente la posibilidad de realizar solicitudes a la API si los encabezados de solicitud HTTP "client_id" y "client_secret" están configurados correctamente.

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 ("#").