Introducción

En este apartado API de Apiges Pro se va a documentar todo lo relacionado con la API de Apiges Pro. Desde la instalación, hasta la utilización de la misma, con casos de uso para la realización de un ciclo completo.

Antes de comenzar con cada uno de los bloques siguientes, una breve introducción sobre la API de Apiges Pro y sus características.

La API de Apiges Pro es la principal vía para obtener, modificar, crear y eliminar datos relacionados con las todas las entidades de Apiges Pro, y cuenta con una serie de características para hacer su uso mucho más fácil:

Autenticación por JWT: Entre estas características, se encuentra el método de autenticación que hemos desarrollado para hacer la API segura. Este método consiste en autenticación por JWT, que permite generar un token de acceso con fecha de expiración (en este caso, diario) en base a un nombre de usuario y contraseña. Este token es personalizado para cada usuario, y tiene unos roles específicos sobre cada uno de los ámbitos (esta última gestión la realizamos desde Grupo 10).
API cómo servicio: Hemos desarrollado la API como un servicio de Windows. Esto permite que la instalación sea un proceso mucho más fácil, en menos tiempo y sin necesidad de desplegar un IIS. Después de la instalación del servicio y el arranque del mismo, se puede empezar a utilizar la API en el dominio y puerto que se ha configurado.
Swagger: Hemos incluido la herramienta Swagger para la especificación de la API, lo cual permite tener una visión clara y concisa acerca de qué peticiones podemos realizar (endpoints), y con qué parámetros para obtener los resultados que esperamos.
Actualización automática de versiones: Además, hemos incluido un servicio adicional de actualización de versiones. Una vez instalado el servicio de actualización, este se encuentra en continua ejecución, comprobando si existen actualizaciones de manera automática. En caso de existir una nueva versión, el servicio se encargará de actualizar la API con la nueva versión. La gestión de actualizaciones y versiones se realiza desde Grupo10.

Bloques:

Instalación: Contiene información acerca de la instalación, tanto de la API como del servicio de actualización automática.
Peticiones: En este bloque se van a detallar las especificaciones de cada una de las peticiones de manera independiente con ejemplos.
Flujo de peticiones: Conjunto de peticiones para realizar un ciclo completo de la API. Este flujo de peticiones va, desde el método de acceso a la API, hasta la modificación de un campo de alguna de las entidades de Apiges Pro.
Soporte: Guía de ayuda.