Generar el token de acceso de la API
Rutas: Configuraciones → Permisos (grupo de API) y Usuarios → [usuario] → Registro → Permisos
Visión general
El token de acceso identifica al usuario que llama a la API de ¡Hola! Suite y vale como una contraseña. Se genera para un usuario que tiene el acceso a la API liberado y un grupo de permisos de API vinculado. Así, la integración solo accede a los datos que el grupo permite. Consulta cómo funciona la API en API de ¡Hola! Suite.
Requisitos previos
- Permiso Grupos de permiso, para crear el grupo de API.
- Permiso Cambiar permisos de los usuarios, para liberar el acceso a la API y generar el token. Sin él, el sistema muestra el aviso Edición de permisos bloqueada.
- Un usuario para la integración. Se recomienda un usuario solo para la API. Consulta Usuarios.
Paso a paso
Crear el grupo de permisos de API
- Accede a Configuraciones → Permisos.
- Haz clic en Añadir nuevo.
- Completa los campos:
- Nombre: nombre que identifica el grupo.
- Nivel de acceso: elige una de las opciones (Administrador, Gestor u Operador). En un grupo de API, lo que vale son los permisos de API marcados en la próxima etapa.
- Grupo exclusivo para API: actívalo. Una vez guardado, esta opción no se puede cambiar.
- Haz clic en Guardar.
- Haz clic en el grupo creado y abre la pestaña Permisos.
- Marca los permisos que la integración puede usar y haz clic en Guardar cambios. En un grupo de API nuevo, todos comienzan desmarcados. Consulta lo que libera cada uno en Funciones de cada permiso.
Liberar el acceso a la API para el usuario
- Accede a Usuarios y haz clic en el usuario de la integración.
- En la pestaña Registro, en la sección Permisos, haz clic en Editar información.
- Activa Tiene acceso a la API del sistema.
- En Grupo de permisos de la API, selecciona el grupo creado. El campo es obligatorio cuando el acceso a la API está activo. Solo aparecen grupos exclusivos para API.
- Haz clic en Guardar.
Copiar el token
- Al guardar por primera vez, se abre la ventana Token API generado con éxito, con el Token de autenticación.
- Haz clic en el token para copiarlo.
- Haz clic en Concluir.
La ventana avisa: "Copia el token ahora. Después de cerrar esta ventana, ya no estará visible." Después, la sección Permisos muestra solo el inicio y el final del token. Si no lo copiaste, genera un nuevo token.
Generar un nuevo token
- En el registro del usuario, en la sección Permisos, haz clic en Generar nuevo token.
- Lee el aviso: el token actual se desactiva al instante y todas las integraciones que lo usan dejan de funcionar.
- Haz clic en Generar nuevo token.
- Copia el nuevo token y haz clic en Concluir.
- Actualiza el token en todas las integraciones que usaban el anterior.
Resultado esperado
El usuario pasa a tener un token de autenticación. La integración envía ese token en el encabezado Authorization de cada solicitud y accede solo a lo que el grupo de API permite.
Si desactivas Tiene acceso a la API del sistema y guardas, el token y el vínculo con el grupo de API se eliminan.
Problemas comunes
| Síntoma | Qué verificar |
|---|---|
| El botón Generar nuevo token no aparece | El acceso a la API del usuario aún no fue liberado. Activa Tiene acceso a la API del sistema y guarda. |
| El botón Generar nuevo token está bloqueado | Tu grupo no tiene el permiso Cambiar permisos de los usuarios. |
| El campo Grupo de permisos de la API no lista el grupo | El grupo debe haberse creado con Grupo exclusivo para API activo. |
| La integración dejó de funcionar | Se generó un nuevo token. Actualiza el token en la integración. |
La API responde error 403 | El grupo de API no tiene el permiso del recurso, o la red de origen no está en las Redes permitidas. Consulta [[api-hola-suite |
Buenas prácticas
- Guarda el token en un gestor de contraseñas, no en planillas ni en mensajes.
- Usa un usuario y un grupo de API por integración, para poder cambiar el token de una sin afectar a las otras.