API ¡Hola! Suite

Introducción

La API ¡Hola! Suite permite la integración y manipulación de datos de la plataforma ¡Hola! Suite mediante solicitudes autenticadas. Esta documentación detalla el proceso de generación y utilización de tokens de acceso para la API.

Token de Acceso

Definición

Un token de acceso es un método de autenticación esencial para operar la API del ¡Hola! Suite. Funciona como una llave digital que garantiza la seguridad en la transferencia de datos.

Función

• Proporciona seguridad en la transferencia de datos
• Garantiza que los datos sean proporcionados solo a solicitantes autenticados
• Limita el acceso de los desarrolladores solo a los datos necesarios para sus aplicaciones

Seguridad

El token de acceso funciona como una contraseña, permitiendo acceso controlado y seguro a la API.

Proceso de Generación del Token

Configuración de Perfil de Permiso

1. Accede al Menú → Configuraciones → Permisos
2. Crea un nuevo permiso del tipo API
3. Define qué datos de la plataforma la API tendrá permiso de manipular

Configuración de Usuario

1. Navega hasta Menú → Usuarios

2. Opciones:

   • Crea un nuevo usuario específico para acceso API
   • Edita un usuario existente para permitir acceso a la API

3. En el registro del usuario:

   • Marca el parámetro "Permitir acceso a la API"
   • Accede a la pestaña "API" que será habilitada
   • Vincula el perfil de permiso creado anteriormente al usuario

4. Haz clic en Guardar

Obtención del Token

Después de guardar las configuraciones, el token de acceso será generado automáticamente. Copia este token para utilizarlo en las solicitudes a la API.

Documentación API

Para acceder a nuestra documentación API, accede a: https://api.opasuite.com.br/

Temas que pueden realizarse a través de la API

• Atenciones
• Mensajes
• Canales de comunicación
• Plantillas de mensaje
• Cliente
• Usuario
• Contactos
• Etiqueta
• Notificación
• Departamentos
• Motivos
• Períodos

Flujo de Generación del Token

Consideraciones Finales

• Mantén el token de acceso en seguridad
• No compartas el token con terceros no autorizados
• Considera la rotación periódica del token para mayor seguridad