¿Cómo crear la API de Ventry para integraciones externas?
En este tutorial vas a aprender cómo crear una API privada dentro de Ventry para conectar la plataforma con cualquier sistema externo. También vas a obtener el Secret Token y el Location ID, los dos datos que necesitará el desarrollador para realizar la integración.
Cómo hacerlo paso a paso
Acceder a las Integraciones Privadas
Ingresá a tu cuenta de Ventry.
Desde el menú lateral, dirigite a Configuración (Settings).
Buscá la sección Private Integrations (Integraciones Privadas), ubicada debajo del apartado Integraciones.
Desde esta sección se administran todas las API privadas disponibles para conectar Ventry con aplicaciones externas.
Crear una nueva integración
Presioná Crear nueva.
Completá el nombre de la integración.
Por ejemplo:
Aplicación ejemplo
Integración ERP
Sistema Contable
Integración Web
La descripción es opcional y únicamente sirve para identificar la integración.
Configurar los permisos
Seleccioná los permisos que tendrá la API.
Los permisos determinan exactamente a qué información y funcionalidades podrá acceder el sistema externo.
Es importante tener presente que cualquier desarrollador que utilice este token podrá acceder únicamente a los recursos habilitados mediante estos permisos.
Si no tenés claro qué permisos necesita la integración, la recomendación es:
Desmarcar únicamente el permiso Usuarios.
Mantener el resto de los permisos habilitados.
Generar el Secret Token
Desplazate hasta el final de la página.
Presioná Crear.
Ventry generará automáticamente el Secret Token, que será la clave privada utilizada para autenticar la integración.
Copiá este token y guardalo inmediatamente en un lugar seguro.
Rotar el Secret Token cuando sea necesario
Una vez creada la integración, el Secret Token dejará de mostrarse por motivos de seguridad.
Si necesitás volver a obtener una clave:
Ingresá nuevamente a la integración.
Utilizá la opción Rotar Token.
Copiá el nuevo Secret Token generado.
Cada vez que se rota el token, el anterior deja de ser válido y deberá actualizarse también en la integración externa.
Obtener el Location ID
Volvé a Configuración (Settings).
Ingresá en Business Profile (Perfil de empresa).
Buscá el campo Location ID.
Este identificador es único para cada cuenta y será necesario para completar la conexión con Ventry.
Compartir la información con el desarrollador
Para comenzar la integración únicamente deberás entregar estos dos datos:
Secret Token
Location ID
Con esa información el desarrollador podrá comenzar a conectar Ventry con cualquier plataforma o sistema externo.
Recomendaciones y buenas prácticas
Utilizá nombres descriptivos para identificar fácilmente cada integración privada.
Compartí el Secret Token únicamente con el desarrollador responsable de la integración.
Guardá el Secret Token apenas se genere, ya que luego dejará de visualizarse.
Si el token se pierde o necesitás reemplazarlo, utilizá la opción Rotar Token para generar uno nuevo.
Revisá cuidadosamente los permisos antes de crear la integración, ya que definirán el nivel de acceso que tendrá el sistema externo sobre tu cuenta de Ventry.
