Skip to main content
📋 Se aplica a: Admin · Partner AdminMódulo: Public API / IntegrationsLa API pública de Alvys permite a su empresa conectar herramientas externas a sus datos de Alvys mediante credenciales de API y un token de API. Esta descripción general explica qué es la API pública, dónde generar sus credenciales y dónde encontrar la documentación completa para desarrolladores.

​
Resumen

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 solo 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, de modo que cada conexión queda vinculada a su empresa y se autentica en cada solicitud. La documentación técnica de referencia completa, incluidos endpoints y guías de configuración, está en la documentación para desarrolladores de Alvys: https://docs.alvys.com/

​
Dónde encontrarla

Usted genera y administra sus credenciales de la API pública de Alvys dentro de la plataforma Alvys en Profile > API. Esta es la página donde crea las aplicaciones cliente, las claves de API y los tokens que autentican una herramienta externa para acceder a sus datos de Alvys. Abrir la página API requiere el rol “Admin” o “Partner Admin”.

​
Conceptos clave

Las credenciales de API identifican una conexión entre una herramienta externa y su cuenta de Alvys. Cuando crea una aplicación cliente en la página Profile > API, Alvys emite las credenciales que la herramienta externa usa 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 conectada lo incluye en cada llamada. Las aplicaciones cliente se pueden crear, listar, actualizar y eliminar desde la página API, de modo que puede revisar conexiones existentes y eliminar las que ya no necesite.

​
Cómo usarla

  1. Inicie sesión en Alvys con el rol “Admin” o “Partner Admin”.
  2. Vaya a Profile > API para abrir la página Public API.
  3. Cree una aplicación cliente para generar las credenciales de API de la herramienta que desea conectar.
  4. Genere un token de API para autenticar las solicitudes de la conexión.
  5. Use la documentación para desarrolladores de Alvys en https://docs.alvys.com/ para obtener detalles de endpoints e instrucciones de configuración para su herramienta específica.

​
Solución de problemas

Si una conexión que antes funcionaba deja de responder, compruebe si su aplicación cliente ha expirado. Una aplicación cliente puede configurarse para expirar en una fecha que usted elija, y las aplicaciones cliente expiradas se desactivan automáticamente, por lo que deberá emitir nuevas credenciales para restaurar la conexión. Si no puede actualizar una aplicación cliente antigua desde la página API actual, se creó con el formato de credenciales heredado; cree una nueva aplicación cliente. Si no puede abrir la página Profile > API, confirme que su cuenta tiene el rol “Admin” o “Partner Admin”, ya que los usuarios sin uno de estos roles no pueden ver ni administrar credenciales.

​
Configuración y permisos

Generar y administrar credenciales de la API pública de Alvys requiere el rol “Admin” o “Partner Admin”. Los usuarios sin uno de estos roles no pueden abrir la página Profile > API ni crear, ver, actualizar o eliminar aplicaciones cliente. Como la misma página controla todas las acciones de credenciales, otorgar a un usuario la capacidad de crear credenciales también le permite ver, actualizar y eliminar aplicaciones cliente existentes.

​
Límites y comportamiento

Una aplicación cliente puede configurarse para expirar en una fecha que usted elija al crearla o actualizarla. Las aplicaciones cliente expiradas se desactivan automáticamente, por lo que una conexión que dependía de credenciales expiradas 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 API actual; cree una nueva aplicación cliente.

​
Preguntas frecuentes

P: ¿Dónde genero mis credenciales de la API de Alvys? R: Genérelas dentro de la plataforma Alvys en Profile > API. Necesita el rol “Admin” o “Partner Admin” para abrir esa página. P: ¿Dónde encuentro la documentación completa de la API de Alvys? R: La documentación para desarrolladores de Alvys está disponible en https://docs.alvys.com/.