Utilisation du tableau de bord de l’API

L’API Zendesk est prise en charge par un tableau de bord dans le Centre d’administration. Les tableaux de bord de l’API vous permettent de réaliser les tâches suivantes :

• Activation de l’accès par mot de passe ou par token
• Création et gestion des tokens API
• Création et gestion des clients OAuth
• Suivi de l’activité de l’API par rapport à votre limite de taux
• Obtention d’informations au sujet des échecs des cibles URL

Seuls les administrateurs Zendesk Support ont accès au tableau de bord de l’API.

Remarque – Les comptes d’essai sont limités à un maximum de 2 cibles.

Pour en savoir plus au sujet de l’utilisation de l’API Zendesk, consultez les pages suivantes :

• Introduction de l’API REST sur developer.zendesk.com
• Guide de l’API Zendesk sur help.zendesk.com
• Communauté de l’API Zendesk

Activation de l’accès par mot de passe ou par token

1. Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Zendesk.
2. Dans l’onglet Paramètres, activez l’accès par mot de passe ou par token.

Création et gestion des tokens API

1. Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Zendesk.
2. Vérifiez que l’onglet Paramètres est sélectionné.
3. Pour créer un token, cliquez sur l’icône Plus (+) sur le côté droit.
4. Pour supprimer un token, cliquez dessus dans la liste, puis cliquez sur Supprimer sur le côté droit.

Plusieurs tokens peuvent être actifs en même temps. Si vous supprimez un token, il est désactivé de façon permanente.

Pour en savoir plus, consultez la section portant sur les tokens API sur developer.zendesk.com.

Création et gestion des clients OAuth

1. Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Zendesk.
2. Sélectionnez l’onglet Clients OAuth.
3. Créez un client en suivant les instructions de l’article Enregistrement de votre application auprès de Zendesk.

Suivi de l’activité de l’API par rapport à votre limite de taux

Vous pouvez comparer l’activité des dernières 24 heures avec l’API principale par rapport à votre limite de taux.

Pour suivre l’activité de l’API

1. Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Zendesk.
2. Cliquez sur l’onglet Activité.

Les demandes suivantes sont exclues de l’activité :

• Demandes du centre d’aide et de l’API Talk.
• Demandes utilisant l’authentification de session, comme les demandes effectuées par les applications Zendesk ou les demandes côté client effectuées par le code JavaScript dans le centre d’aide.
• Demandes anonymes sans authentification.

La page affiche l’activité au cours des dernières 24 heures. Le graphique couvre les demandes au fil du temps et le tableau présente le détail du total des demandes par client. Les clients sont identifiés par identifiants d’authentification utilisés. Le tableau répertorie les noms ou identités des tokens API, des clients OAuth ou des utilisateurs pour une authentification élémentaire.

Le graphique évolue en fonction du volume d’activité, et la ligne de la limite de taux peut être masquée. Avec une activité suffisante dans l’exemple, une ligne horizontale représentant la limite de taux s’afficherait au niveau de 700 demandes.

L’échelle horaire horizontale est définie sur notre heure locale, et la marque la plus à droite représente l’heure la plus récente.

Pic des demandes est le nombre le plus élevé de demandes en une minute donnée au cours de l’heure. Moyenne des demandes/min est le nombre moyen de demandes par minute donnée au cours de l’heure.

Remarque – Le graphique n’inclut pas les limites de taux spécifiques aux points de fin, comme ceux pour les exportations supplémentaires.

Obtention d’informations au sujet des échecs des cibles URL

Si vous rencontrez des problèmes avec une cible URL, vous pouvez consulter les informations renvoyées par le service tiers ou l’API REST auquel ou à laquelle la cible a essayé d’accéder.

Pour afficher les informations sur les échecs des cibles

1. Dans le Centre d’administration, cliquez sur Applications et intégrations dans la barre latérale, puis sélectionnez API > API Zendesk.
2. Cliquez sur l’onglet Échecs de la cible.

Exemple :

Cliquez sur un élément de la liste pour voir plus de détails au sujet du problème.

Remarque – Les informations sur l’échec proviennent de la réponse envoyée par le service tiers. Pour en savoir plus, consultez la documentation du service.