Anjana Data Platform expone todas sus funcionalidades no solo a través del Portal de Datos, sino también mediante una API pública documentada, que permite la interacción de los usuarios y la interconexión con otras piezas de software externas a la plataforma.
Acceso a la documentación de la API
La documentación de la API se presenta mediante Swagger, donde se consulta el listado de servicios disponibles. Puede accederse desde el Portal de Datos, mediante el menú de navegación, mediante la opción Documentación de API. Está disponible para los usuarios cuyo rol tenga el permiso API_DOC.
Exploración de los servicios en Swagger
Con el selector de la parte superior derecha se cambia entre los distintos microservicios disponibles. Al seleccionar un módulo, se muestran todas las llamadas disponibles en él y, para cada servicio, un ejemplo de los parámetros de entrada y de las posibles salidas que devuelve.
Autenticación de las peticiones
Las llamadas están securizadas, por lo que es necesario configurar Swagger para que añada el token de autorización en la cabecera. Para ello se utiliza el botón Authorize. Una vez autorizado, el candado de cada llamada pasa a estado cerrado y ya es posible ejecutar las peticiones.
Formato de las peticiones
Para invocar un servicio de los documentados, la petición se construye con el siguiente formato, a través del gateway de la plataforma:
-
<http|https>://<domain>/gateway/<url indicada en la documentación>
Este apartado está dirigido principalmente a desarrolladores y equipos técnicos que integran sus procesos con Anjana Data Platform a través de su API.