Este artículo proporciona información general sobre la administración de los clientes de API de Chat y los tokens de OAuth. Explica paso a paso cómo crear y borrar los clientes existentes, además de cómo crear y revocar los tokens de acceso de OAuth.
Los clientes de API se utilizan para crear tokens de acceso de OAuth con los que autenticar las solicitudes de API. Si tiene una cuenta autónoma de Legacy Chat, hay dos maneras de autenticar las solicitudes de API:
- Autenticación básica con un nombre de usuario y una contraseña
- Token de acceso de Oauth
Si tiene una cuenta de Chat+Support o de Fase 4, solo hay una manera de autenticar las solicitudes de API:
- Token de acceso de Oauth
Si desea más información sobre los distintos tipos de cuentas de Chat, consulte Acerca de los tipos de cuentas de Chat. Si desea ver los detalles de la autenticación de la API, consulte Security and Authentication en la documentación de la API de Chat.
Este artículo contiene las siguientes secciones:
- Administrar clientes de API
- Crear clientes de API
- Borrar clientes de API
- Crear tokens
- Revocar tokens
- Recursos adicionales
Administrar clientes de API
Los administradores pueden ver y borrar fácilmente cualquiera de sus clientes de API activos desde la interfaz de Chat. Los usuarios solo pueden ver los clientes que ellos mismos han creado.
Para ver los clientes activos, vaya al panel de Chat y seleccione Configuración > Cuenta > API y SDK.
Desde aquí, puede seleccionar el cliente que desea ver y actualizar. También puede volver a generar el secreto de cliente o borrar el cliente.
Crear clientes de API
Si está creando tokens de OAuth para uso interno, siga estas instrucciones. Si el cliente es para una integración de terceros, siga las instrucciones de instalación proporcionadas por el desarrollador.
Para crear un cliente, vaya al panel de Chat y seleccione Configuración > Cuenta > API y SDK y luego haga clic en el botón Agregar cliente API.
Si desea ver instrucciones detalladas para rellenar los campos de cliente, consulte Adding an API client en la documentación sobre la API de Chat.
Borrar clientes de API
Antes de borrar un cliente, verifique cómo pueden verse afectados los servicios de terceros. Si el cliente tiene el campo URL de redireccionamiento establecido en cualquier cosa que no sea localhost, lo más probable es que el cliente esté interactuando con una integración externa. Si borra el cliente, tendrá que crear otro. Durante el proceso de creación del token, los usuarios de la integración externa tendrán que volver a dar a la integración acceso a sus cuentas de Chat. Si el URL de redireccionamiento es localhost, lo más probable es que el cliente haya sido creado para uso interno de la API.
Para borrar un cliente
- En el panel de Chat, seleccione Configuración > Cuenta > API y SDK y luego seleccione el cliente en la lista.
- Haga clic en el botón Borrar seleccionados.
Los clientes de API también se pueden administrar a través de la API. Consulte OAuth Clients en la documentación de la API.
Crear tokens
Una vez que tenga un cliente de API, podrá crear un token de acceso de OAuth para autenticar las solicitudes de API.
Hay dos maneras de crear un token de acceso: una forma más larga y más formal para los entornos de producción, y una más corta y más conveniente para los entornos de prueba.
Si desea instrucciones para ambos métodos, consulte Generación de un token de API de REST para cuentas integradas de Chat.
Revocar tokens
Un token puede ser revocado únicamente por el usuario que lo creó. Los administradores no cuentan con los permisos necesarios para revocar tokens creados por otros usuarios.
Utilice la API para tokens OAuth para revocar un token. El procedimiento consta de los siguientes pasos:
- Haga una lista de sus tokens para obtener la ID del token que desea borrar.
Consulte List Tokens en la documentación de la API.
Si tiene varios tokens, es útil saber la fecha y hora aproximada de creación del token para poder identificarlo en la lista.
- Revoque el token en función de la ID.
Consulte Revoke Token en la documentación de la API.
Recursos adicionales
Este artículo proporciona información general sobre los clientes de API y los tokens de acceso de OAuth. Si desea más información, consulte los siguientes artículos:
- OAuth Authentication en la documentación de la API de Chat
- Generación de un token de API de REST para Chat