¿Cómo se autentican las solicitudes de la API?

Pregunta

¿Cómo se autentican las solicitudes de la API usando una de las API de Zendesk v2?

Respuesta

Es necesario ser un usuario verificado para hacer solicitudes de API. Para autenticar las solicitudes de API, puede usar la autenticación básica con su dirección de correo electrónico y contraseña, su dirección de correo electrónico y un token de API, o un token de acceso de OAuth.

Todos los métodos de autenticación establecen el encabezado de la autorización de manera diferente. Las credenciales enviadas en la carga o la URL no se procesan.

Para ver información sobre cada método de autenticación, haga clic en cada una de las pestañas a continuación.

Autenticación de contraseña

Autenticación de token de API

Autenticación de token de acceso OAuth

Autenticación de contraseña

Si usa la autenticación básica, puede combinar su dirección de correo electrónico y contraseña para generar el encabezado de la autorización. La combinación de dirección de correo electrónico y contraseña debe ser una cadena con codificación Base 64. Si desea ver un ejemplo de cómo formatear el encabezado de la autorización, consulte el bloque de código a continuación.

Authorization: Basic {base-64-encoded email_address:password}

Autenticación de token de API

Si se usa un token de API, puede combinar su dirección de correo electrónico y token de API para generar el encabezado de la autorización. La combinación de la dirección de correo electrónico y el token de API debe ser una cadena con codificación Base-64. Si desea ver un ejemplo de cómo formatear el encabezado de la autorización, consulte el bloque de código a continuación.

Authorization: Basic {base-64-encoded email_address/token:api_token}

Autenticación de token de acceso OAuth

Si usa OAuth para la autenticación, formatee el encabezado de la autorización como se muestra a continuación.

Authorization: Bearer oauth_access_token

Para obtener más información, consulte este artículo: Uso de la autenticación OAuth con su aplicación.

Ver el encabezado de la autorización

Para ver exactamente lo que envía su aplicación, utilice una página de terceros como Request Bin. Compare sus encabezados con los que genera un webhook usando una autenticación OAuth. Apunte el webhook a la URL requestb.in y, en la página Agregar webhook, haga clic en Probar webhook para verlo en acción:

Una vez que la solicitud llega a su requestb.in, se ve así:

La cadena después Authorization: Bearer es la clave de API proporcionada por RequestBin en la configuración de su cuenta en Acceso programático.

Si usa python para hacer solicitudes, configure los encabezados de la sesión de la siguiente manera:

session = requests.Session()
session.headers = {'Content-Type': 'application/json', 'Authorization': 'Basic Basic_64_encoded_code'}

Si desea más información, consulte la documentación para programadores. Seguridad y autenticación.