Los usuarios pueden acceder a la API de Zendesk a través de dos métodos de autenticación. La primera opción es usar una contraseña generada automáticamente que se llama token de API. La segunda, usar un token de acceso de OAuth, que es diferente de un token de API.
Los dos métodos de autenticación están desactivados de manera predeterminada en las cuentas nuevas. Este artículo explica cómo activar y desactivar cada método para administrar cómo los usuarios acceden a la API de Zendesk.
Si desea información sobre cómo usar la API de Zendesk, consulte las páginas siguientes:
Administrar el acceso con token de API a la API
Los usuarios pueden usar un token de API para autenticar las solicitudes de API. Los tokens de API son contraseñas generadas automáticamente que se pueden usar con su nombre de usuario para autenticar las solicitudes de API. También se pueden usar como parte de la autenticación de dos factores para las integraciones. Cada token de API puede ser usado por cualquier usuario verificado en la cuenta y no está asociado con ningún usuario en particular. Puede haber más de un token activo a la vez.
Los tokens de API no son lo mismo que los tokens de acceso de OAuth. Consulte Differences between API tokens and access tokens (Diferencias entre los tokens de API y los tokens de acceso) en developer.zendesk.com.
Para usar un token de API para autenticar las solicitudes de API, consulte API token (Token de API) en developer.zendesk.com.
Activar el acceso con token de API
El acceso con token de API está desactivado de manera predeterminada. Para que los usuarios puedan usar tokens de API, es necesario activar el acceso con token de API en el Centro de administración.
Para activar el acceso con token de API
- En el Centro de administración, haga clic en
Aplicaciones e integraciones en la barra lateral y luego seleccione API > API de Zendesk. - En la pestaña Configuración, active el acceso con token.
Generar tokens de API
Para generar un token de API, debe ser un administrador y el acceso con token de API tiene que estar activado en su cuenta.
Para generar un token de API
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione API > API de Zendesk.
- Haga clic en el botón Agregar token de API a la derecha de Tokens de API activos.
El token se genera y se muestra.
- (Opcional) Ingrese una descripción para el token de API.
- Copie el token y péguelo en un lugar seguro. Cuando haga clic en Guardar para cerrar esta ventana, no se volverá a mostrar el token completo.
- Haga clic en Guardar para volver a la página de API de Zendesk.
Si hace clic en el token para volver a abrirlo, se mostrará una versión truncada del token.
Borrar un token de API
Un token de API es como una contraseña: cualquier usuario verificado en la cuenta o cualquier persona con su dirección de correo electrónico puede utilizarlo para autenticar las solicitudes de API. Si se entera de que un token de API se ha visto comprometido, bórrelo de inmediato. Cuando se borra un token se desactiva de forma permanente.
Para borrar un token de API
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione API > API de Zendesk.
- Seleccione el token en la lista y luego haga clic en Borrar en el lado derecho.
Administrar el acceso con token de OAuth a la API
Puede usar tokens de acceso de OAuth para autenticar las solicitudes de API. OAuth brinda una manera segura para que las aplicaciones puedan tener acceso a los datos de Zendesk sin tener que almacenar ni usar los tokens de API, que son información confidencial.
Los tokens de acceso de OAuth no se pueden crear directamente en el Centro de administración como los tokens de API. Primero se debe crear un cliente OAuth en el Centro de administración para luego usarlo en un flujo de autorización de OAuth definido para crear un token de acceso de OAuth.
Los tokens de acceso de OAuth no son lo mismo que los tokens de API. Consulte Differences between API tokens and access tokens (Diferencias entre los tokens de API y los tokens de acceso) en developer.zendesk.com.
En esta sección se tratan los siguientes temas:
Para autenticar las solicitudes de API con tokens de acceso de OAuth, consulte OAuth access token (Token de acceso de OAuth) en developer.zendesk.com.
Crear clientes OAuth
Los clientes OAuth le permiten crear tokens de acceso de OAuth que se pueden utilizar para autenticar las solicitudes de API. Los tokens de acceso de OAuth son distintos de los tokens de API y brindan una manera segura para que las aplicaciones puedan tener acceso a la API de Zendesk sin necesidad de almacenar ni usar los tokens de API de los usuarios de Zendesk.
Para crear clientes OAuth
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione API > API de Zendesk.
- Seleccione la pestaña Clientes OAuth.
- Para crear un cliente, haga clic en el botón Agregar cliente OAuth y siga las instrucciones que se indican en Registrar su aplicación en Zendesk.
- Para borrar un cliente, seleccione el cliente en la lista y luego haga clic en Borrar en el lado derecho.
A continuación, use el cliente OAuth para crear uno o más tokens de acceso de OAuth.
Crear tokens de acceso con un cliente OAuth
Después de crear un cliente OAuth en el Centro de administración, puede utilizarlo con un flujo de autorización definido para crear tokens de acceso de OAuth.
Otra posibilidad es usar el cliente OAuth con la API para crear tokens de acceso sin un flujo de autorización. Puede usar un token de API para autenticar estas solicitudes de API. Consulte Creating and using OAuth access tokens with the API (Creación y uso de los tokens de acceso de OAuth con la API) en developer.zendesk.com.
Borrar clientes y tokens de OAuth
Puede borrar un cliente OAuth para desactivar todos los tokens de acceso creados con el cliente. También puede revocar tokens de acceso individuales.
Para borrar un cliente OAuth
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione API > API de Zendesk.
- Seleccione la pestaña Clientes OAuth.
- Seleccione el cliente en la lista y luego haga clic en Borrar en el lado derecho.
Para revocar un token de acceso específico
- Consulte Revoking an access token (Revocar un token de acceso) en developer.zendesk.com.