AHORA Connect - Uso de la API

El apartado API, accesible desde el menú Connect de AHORA Connect, permite gestionar toda la configuración técnica relacionada con la publicación y el uso de los servicios disponibles en la API.

Este mantenimiento constituye el punto central de acceso para administradores y desarrolladores que necesiten definir, revisar o probar los objetos y procesos publicados hacia aplicaciones externas.

1. Documentación integrada

La propia plataforma incluye la documentación completa de la API, accesible desde este mantenimiento.
AHORA Connect publica automáticamente un Swagger totalmente funcional, que permite:

• Consultar los objetos (endpoints) publicados.

• Visualizar su estructura, parámetros de entrada y salida y códigos de respuesta.

• Ejecutar pruebas directas de los endpoints sin necesidad de herramientas externas.

Esta documentación interactiva facilita la comprensión del funcionamiento de cada objeto y acelera el desarrollo e integración de sistemas externos con AHORA ERP.

2. Publicación y configuración de servicios

Desde el mantenimiento API, el administrador puede:

• Configurar los parámetros generales de la API, como autenticación, seguridad o control de acceso.

• Publicar o despublicar objetos (endpoints) que se encuentren definidos en el sistema.

• Actualizar la documentación del Swagger, de modo que refleje en tiempo real cualquier cambio realizado en la configuración.

De esta manera, la API siempre mantiene una correspondencia directa entre los servicios configurados y su documentación de uso.

3. Uso del Swagger

Una vez accedido al Swagger desde el mantenimiento, se pueden ejecutar operaciones de prueba sobre los endpoints configurados.

El Swagger permite:

• Realizar llamadas GET, POST, PUT o DELETE según el tipo de objeto.

• Introducir los valores requeridos en el cuerpo de la petición.

• Obtener respuestas estructuradas que muestran tanto el resultado de la llamada como los posibles mensajes de error o validación.

Estas pruebas no modifican la configuración de la API, pero sí permiten verificar que los objetos están correctamente publicados y operativos.

4. Uso externo de la API

Además del mantenimiento interno, AHORA Connect dispone de un acceso directo a un nodo de ayuda denominado Web API Help, desde el cual se puede consultar documentación técnica adicional orientada a la integración externa.

En este apartado se incluyen ejemplos prácticos sobre:

• Autenticación OAuth

• Obtención y uso de Access Token y Refresh Token

• Cabeceras y estructura de las peticiones HTTP

• Formatos de respuesta y códigos de error

Esta información es fundamental para los desarrolladores que deseen conectar herramientas externas o automatizar procesos mediante el consumo de los endpoints publicados.

Asimismo, es posible descargar el archivo JSON del Swagger, que puede importarse directamente en swagger.io o herramientas similares.

De esta forma, los desarrolladores pueden generar automáticamente el mapeo de la API y obtener los métodos predefinidos en el lenguaje de programación que elijan (C#, Python, Java, JavaScript, etc.), simplificando la integración con AHORA Connect.

5. Buenas prácticas

Para un uso correcto del mantenimiento API, se recomienda:

• Verificar que los objetos y procedimientos asociados estén correctamente definidos en sus respectivos mantenimientos.

• Publicar únicamente los endpoints necesarios para cada integración externa.

• Revisar periódicamente la documentación generada en el Swagger, especialmente tras actualizaciones de versión o cambios en la estructura de datos.