Integración de API
Conectividad de la API
ENICO ofrece una API REST de lectura que permite acceder a toda la información del aplicativo a través de una serie de endpoints REST que exponen las entidades y datos clave del sistema. Esta API está diseñada para facilitar la integración y consulta de la información almacenada en ENICO desde otras aplicaciones o sistemas externos. La API cumple con los estándares de OpenAPI 3, lo que asegura que esté bien documentada y organizada para facilitar su uso.
Documentación de la API
Dentro de ENICO, al hacer clic en Ajustes > API, se puede acceder a una página con la documentación completa de la API. Esta documentación incluye todos los endpoints disponibles y permite consultar detalles sobre el funcionamiento de cada uno, los parámetros necesarios y las estructuras de respuesta. Además, la interfaz proporciona herramientas de prueba que permiten realizar consultas en tiempo real a la API directamente desde el navegador, lo que facilita la comprensión y testeo de los diferentes puntos de conexión.
Credenciales de API y autenticación mediante token
El acceso a la API en ENICO se realiza mediante un sistema de autenticación de tokens. Para obtener un token de acceso, el usuario debe crear una credencial de API en la pantalla de Credenciales de API, disponible en los ajustes del sistema. Este proceso permite generar tantas credenciales como sean necesarias, y cada credencial se puede personalizar con un nombre, facilitando así la identificación de cada token en caso de uso múltiple o compartido entre varios sistemas.
Las credenciales de API deben mantenerse seguras y ocultas, ya que cada token permite el acceso a los datos expuestos por la API. ENICO permite gestionar de forma flexible las credenciales generadas, pudiendo revocar o eliminar cualquier credencial de API en caso necesario. Esto resulta útil para asegurar la privacidad y protección de los datos en situaciones en las que se sospeche de un acceso indebido o si un sistema ya no necesita conectarse a la API.
Ejemplo de revocación de acceso
Imaginemos que una credencial de API se generó para un sistema externo que ya no está en uso o que ha sido reemplazado. En este caso, el administrador puede acceder a Credenciales de API en ENICO, localizar la credencial correspondiente y revocar el token asociado. Esta acción desactiva inmediatamente el acceso de esa credencial, asegurando que ya no pueda utilizarse para consultar la API. Esta funcionalidad es útil también en caso de pérdida de seguridad o sospecha de que una credencial haya sido comprometida, permitiendo una respuesta rápida y efectiva para proteger los datos del sistema.
El sistema de credenciales de API de ENICO asegura una gestión controlada y segura del acceso a la información, proporcionando una solución flexible y robusta para integraciones externas.
