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 authentifiées. Pour authentifier les demandes API, vous pouvez utiliser 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. Chaque option est répertoriée ci-dessous :

• Authentification par mot de passe
• Authentification par token API
• Authentification par token d’accès OAuth
• Consultation de votre en-tête d’autorisation

Authentification par mot de passe

Remarque : l’authentification par mot de passe pour nos API est en cours d’abandon. Le délai peut être différent en fonction des schémas de trafic et de la date de création de votre compte. Consultez cette page : Annonce de l’abandon de l’accès par mot de passe pour les API.

Pour utiliser l’authentification de base, activez l’accès par mot de passe dans le Centre d’administration sous Applications et intégrations > API > Configuration de l’API, ainsi que dans la section d’authentification appropriée (pour les membres de l’équipe ou les utilisateurs finaux).

Formatez la combinaison de l’adresse e-mail et du mot de passe en une chaîne codée Base-64. Pour un exemple de formatage de l’en-tête d’autorisation, reportez-vous au bloc de code ci-dessous.

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

Authentification par 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. Formatez la combinaison de l’adresse e-mail et du token API en une chaîne codée Base-64. Pour un exemple de formatage de l’en-tête d’autorisation, reportez-vous au bloc de code ci-dessous.

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

Authentification par token d’accès OAuth

Si vous utilisez OAuth pour l’authentification, formatez l’en-tête d’autorisation ainsi :

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

Pour voir exactement ce que votre application envoie, 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.

Une fois que la demande atteint votre requestb.in, elle ressemble à ce qui 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'}

Remarque : surveillez votre utilisation des API avec le tableau de bord d’utilisation des API et vérifiez les limites de débit éventuelles.

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