La API pública de Alvys (API de Alvys, API pública, API REST) es una forma programática de conectar herramientas y sistemas externos a los datos de su cuenta de Alvys. En lugar de trabajar únicamente dentro de la plataforma Alvys, puede usar la API pública para recuperar sus datos operativos desde otra aplicación, como una herramienta de informes o de inteligencia empresarial. El acceso a la API pública se controla mediante credenciales de API y un token de API que usted genera dentro de Alvys, por lo que cada conexión está vinculada a su empresa y se autentica en cada solicitud. El material de referencia técnica completo, incluidos los puntos finales y las guías de configuración, se encuentra en la documentación para desarrolladores de Alvys: https://docs.alvys.com/

Puedes generar y gestionar tus credenciales de la API pública de Alvys dentro de la plataforma Alvys, en Perfil > API. En esta página, creas las aplicaciones cliente, las claves API y los tokens que permiten autenticar una herramienta externa con tus datos de Alvys. Para acceder a la página de la API, necesitas el rol de "Administrador" o "Administrador de socios" .

Las credenciales de la API identifican la conexión entre una herramienta externa y tu cuenta de Alvys. Al crear una aplicación cliente en la página Perfil > API, Alvys emite las credenciales que la herramienta externa utiliza para identificarse. Un token de API autentica cada solicitud que una herramienta externa envía a la API pública de Alvys. El token es lo que demuestra que una solicitud está permitida, por lo que la herramienta que se conecta lo incluye en cada llamada. Las aplicaciones cliente se pueden crear, listar, actualizar y eliminar desde la página de la API, lo que te permite revisar las conexiones existentes y eliminar las que ya no necesitas.

Si una conexión que antes funcionaba deja de responder, compruebe si su aplicación cliente ha caducado. Puede configurar una aplicación cliente para que caduque en la fecha que usted elija; las aplicaciones cliente caducadas se desactivan automáticamente, por lo que deberá emitir nuevas credenciales para restablecer la conexión. Si no puede actualizar una aplicación cliente antigua desde la página de la API actual, significa que se creó con el formato de credenciales anterior; en ese caso, cree una nueva aplicación cliente. Si no puede abrir la página Perfil > API, confirme que su cuenta tiene el rol de "Administrador" o "Administrador de socios" , ya que los usuarios sin uno de estos roles no pueden ver ni gestionar las credenciales.

Para generar y administrar las credenciales de la API pública de Alvys, se requiere el rol de "Administrador" o "Administrador de socios" . Los usuarios sin uno de estos roles no pueden acceder a la página Perfil > API ni crear, ver, actualizar o eliminar aplicaciones cliente. Dado que esta misma página controla todas las acciones relacionadas con las credenciales, otorgar a un usuario la capacidad de crearlas también le permite ver, actualizar y eliminar las aplicaciones cliente existentes.

Una aplicación cliente puede configurarse para que caduque en la fecha que usted elija al crearla o actualizarla. Las aplicaciones cliente caducadas se desactivan automáticamente, por lo que una conexión que dependía de credenciales caducadas deja de funcionar hasta que emita nuevas. Las aplicaciones cliente heredadas creadas con el formato de credenciales anterior no se pueden actualizar desde la página de la API actual; en su lugar, cree una nueva aplicación cliente.

P: ¿Dónde genero mis credenciales de API de Alvys?

A: Genere estos archivos dentro de la plataforma Alvys, en Perfil > API. Necesita el rol de "Administrador" o "Administrador de socios" para acceder a esa página.

P: ¿Dónde puedo encontrar la documentación completa de la API de Alvys?

R: La documentación para desarrolladores de Alvys está disponible en https://docs.alvys.com/ .