Comment authentifier les demandes API ?

Question

Comment authentifier les demandes API avec l’une des API Zendesk v2 ?

Réponse

Vous devez être un utilisateur vérifié pour effectuer des demandes API. Authentifiez les demandes API en utilisant l’authentification de base avec votre adresse e-mail et votre mot de passe, avec votre adresse e-mail et un token API, ou avec un token d’accès OAuth.

Toutes les méthodes d’authentification définissent différemment l’en-tête d’autorisation. Les identifiants envoyés dans la charge ou l’URL ne sont pas traités.

Cet article inclut des informations sur les sujets suivants :

• Mot de passe
• Token API
• Token d’accès OAuth
• Consultation de votre en-tête d’autorisation

Mot de passe

Si vous utilisez l’authentification de base, vous pouvez combiner votre adresse e-mail et votre mot de passe pour générer l’en-tête d’autorisation. La combinaison adresse e-mail / mot de passe doit être une chaîne codée en Base64. Formatez l’en-tête d’autorisation comme indiqué ci-dessous.

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

Token API

Si vous utilisez un token API, vous pouvez combiner votre adresse e-mail et votre token API pour générer l’en-tête d’autorisation. La combinaison adresse e-mail et token API doit être une chaîne codée en Base64. Formatez l’en-tête d’autorisation comme indiqué ci-dessous.

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

Token d’accès OAuth

Si vous utilisez OAuth pour l’authentification, formatez l’en-tête d’autorisation comme indiqué ci-dessous.

Authorization: Bearer oauth_access_token

Pour en savoir plus, consultez cet article : Authentification OAuth avec votre application.

Consultation de votre en-tête d’autorisation

Si vous voulez voir exactement ce qui est envoyé par votre application, utilisez une page tierce telle que Request Bin. Comparez vos en-têtes à ceux générés par un webhook en utilisant l’authentification OAuth. Pointez le webhook vers votre URL requestb.in et sur la page Ajouter un webhook, cliquez sur Tester le webhook pour voir cela en action :

Dans votre requestb.in, cela apparaît comme suit :

La chaîne suivant Authorization: Bearer est la clé API fournie par RequestBin dans les paramètres de votre compte sous Accès programmatique.

Si vous utilisez Python pour créer des demandes, configurez vos en-têtes de session comme suit :

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

Pour en savoir plus, consultez la documentation destinée aux développeurs : Sécurité et authentification.