Skip to content

Generar el token de acceso de la API ​

Acceso

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 ​

  1. Accede a Configuraciones → Permisos.
  2. Haz clic en Añadir nuevo.
  3. 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.
  4. Haz clic en Guardar.
  5. Haz clic en el grupo creado y abre la pestaña Permisos.
  6. 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 ​

  1. Accede a Usuarios y haz clic en el usuario de la integración.
  2. En la pestaña Registro, en la sección Permisos, haz clic en Editar información.
  3. Activa Tiene acceso a la API del sistema.
  4. 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.
  5. Haz clic en Guardar.

Copiar el token ​

  1. Al guardar por primera vez, se abre la ventana Token API generado con éxito, con el Token de autenticación.
  2. Haz clic en el token para copiarlo.
  3. Haz clic en Concluir.
El token aparece una sola vez

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 ​

  1. En el registro del usuario, en la sección Permisos, haz clic en Generar nuevo token.
  2. Lee el aviso: el token actual se desactiva al instante y todas las integraciones que lo usan dejan de funcionar.
  3. Haz clic en Generar nuevo token.
  4. Copia el nuevo token y haz clic en Concluir.
  5. 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íntomaQué verificar
El botón Generar nuevo token no apareceEl 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á bloqueadoTu grupo no tiene el permiso Cambiar permisos de los usuarios.
El campo Grupo de permisos de la API no lista el grupoEl grupo debe haberse creado con Grupo exclusivo para API activo.
La integración dejó de funcionarSe generó un nuevo token. Actualiza el token en la integración.
La API responde error 403El 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.

Contenidos relacionados ​