...
En este apartado API de ApigesPro se va a documentar todo lo relacionado con la API de Apiges. Desde la instalación, hasta la utilización de la misma, con casos de uso para la realización de un ciclo completo.
...
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 Grupo10).
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 y , 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 y en . En caso de existir una nueva versión, actualizar el servicio se encargará de actualizar la API con la nueva versión. La gestión de actualizaciones y versiones se realiza desde Grupo10.
...
Instalación: Contiene información acerca de la instalación, tanto de la api 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.
Ejemplos de funcionamiento: Conjunto de ejemplos de uso que permitirán realizar un ciclo completo (desde el método de acceso a la api API hasta la modificación de atributo un campo de alguna de las entidades de Apiges).
Soporte: Guía de ayuda.