API-Introducción
INTRODUCCIÓN A LAS APIs de INTEGRACIÓN DE SIMPLE
La Plataforma SIMPLE dispone de dos vías de comunicación:
- Graphical User Interface (GUI) de SIMPLE: el interfaz web de SIMPLE.
- API de SIMPLE: el interfaz para el intercambio de información S2S con SIMPLE.
El API de SIMPLE permite el intercambio bidireccional de datos entre SIMPLE y sistemas externos según la estructura de Envíos y Eventos de SIMPLE, en línea con el Modelo de Datos establecido en la Plataforma SIMPLE.
El intercambio de datos en la plataforma SIMPLE entre usuarios que utilicen el GUI y/o que utilicen el API de SIMPLE, no tendrá diferencias a ningún nivel de compartición de datos. Ambas vías de comunicación, complementarias y a disposición de todos los usuarios de SIMPLE, permitirán el registro y compartición de los mismos datos, según la estructura de Envíos y Eventos y el Modelo de Datos de SIMPLE, tal y como indica la siguiente figura:
De la misma manera, el registro de datos a través del API de SIMPLE se regirá por el mismo sistema de permisos que a través del GUI. Únicamente aquellas Entidades con las que se comparta datos de forma explícita, por parte de una Entidad usuaria de SIMPLE, podrá tener acceso a los mismos, y siempre supeditado a la configuración especifica de la Matriz de Permisos de la misma.
En la actualidad, SIMPLE cuenta con cuatro APIs diferenciadas que ofrecen diferentes servicios:
- API – Authorization. El API que proporciona a los Sistemas Externos el token necesario para identificarse y operar con el resto de APIs del Sistema.
- API – Shipment. El API que permite registrar Envíos y Eventos en la Plataforma SIMPLE, compartiendo datos con otras entidades usuarias de SIMPLE en el marco de un Envío.
- API – Documentation. El API que permite adjuntar y consultar documentos en el marco de un Envío en SIMPLE.
- API – REAT. El API que permite realizar consultas al Registro de Empresas y Actividades de Transporte (REAT) del Ministerio de Transportes y Movilidad Sostenible.
El uso del API de SIMPLE permite automatizar el intercambio de datos entre los sistemas externos de una Entidad usuaria y la plataforma SIMPLE mediante una conexión sistema a sistema (S2S). Esto optimizará las operaciones de comunicación entre los actores de la cadena logística, evitando la introducción de datos de forma reiterada en diferentes aplicaciones y aprovechando su registro en los sistemas de las propias Entidades usuarias para su posterior compartición con el resto de la cadena logística a través de SIMPLE. Para ello, SIMPLE proporciona un Sistema de Notificaciones asíncrono al que podrán suscribirse los Sistemas Externos para recibir información relativa a operaciones realizadas en los envíos en los que estén involucrados y que hayan sido realizadas por otros usuarios a través del API o del GUI.
El intercambio de información relacionada con los Envíos, con y desde SIMPLE, así como los elementos que intervienen en el proceso, se producirá de acuerdo al siguiente esquema de diagrama de secuencia:
