Les utilisateurs disposent de deux méthodes d’authentification différentes pour accéder à l’API Zendesk. Ils peuvent utiliser un mot de passe généré automatiquement, appelé un token API, ou un token d’accès OAuth, qui est différent d’un token API.
Ces deux méthodes d’authentification sont désactivées par défaut dans les nouveaux comptes. Cet article explique comment activer et désactiver chaque méthode pour gérer la façon dont les utilisateurs accèdent à l’API Zendesk.
Pour en savoir plus au sujet de l’utilisation de l’API Zendesk, consultez les pages suivantes :
Gestion de l’accès à l’API avec un token API
Les utilisateurs peuvent utiliser un token API pour authentifier les demandes d’API. Les tokens API sont des mots de passe générés automatiquement que vous pouvez utiliser avec votre nom d’utilisateur pour authentifier les demandes d’API. Vous pouvez aussi les utiliser pour l’authentification à deux facteurs des intégrations. Les tokens API ne sont pas associés à un utilisateur spécifique et peuvent être utilisés par n’importe quel utilisateur vérifié du compte. Plusieurs tokens peuvent être actifs en même temps.
Vous pouvez avoir un maximum de 256 tokens. Si vous avez atteint cette limite, vous devez supprimer un token existant pour en ajouter un nouveau. Les comptes qui ont actuellement plus de 256 tokens ont une limite de 2 048 tokens.
Les tokens API sont différents des tokens d’accès OAuth. Consultez la section sur les différences entre les tokens API et les tokens d’accès sur developer.zendesk.com.
Pour utiliser un token API afin d’authentifier les demandes d’API, consultez la section sur les tokens API sur developer.zendesk.com.
Activation de l’accès par token API
L’accès par token API est désactivé par défaut. Vous devez activer l’accès par token API dans le Centre d’administration pour que les utilisateurs puissent utiliser les tokens API.
Pour activer l’accès par token API
- Dans le Centre d’administration, cliquez sur Applications et intégrations (
) dans la barre latérale, puis sélectionnez API > API Zendesk.
- Dans l’onglet Paramètres, activez l’accès par token.
Génération d’un token API
Pour générer un token API, vous devez être un administrateur et l’accès par token API doit être activé dans votre compte.
Pour générer un token API
- Dans le Centre d’administration, cliquez sur Applications et intégrations (
) dans la barre latérale, puis sélectionnez API > API Zendesk.
- Cliquez sur le bouton Ajouter un token API à droite de Tokens API actifs.
Le token est généré et s’affiche.
- (facultatif) Saisissez une description pour le token API.
- Copiez le token et collez-le à un endroit sûr. Une fois que vous cliquez sur Enregistrer pour fermer cette fenêtre, le token complet ne s’affichera plus jamais.
- Cliquez sur Enregistrer pour retourner à la page des API Zendesk.
Si vous cliquez sur le token pour le rouvrir, vous en voyez une version tronquée.
Suppression d’un token API
Un token API est semblable à un mot de passe : n’importe quel utilisateur vérifié du compte ou n’importe qui avec une adresse e-mail peut l’utiliser pour authentifier les demandes d’API. Si vous pensez qu’un token API a été compromis, supprimez-le immédiatement. Si vous supprimez un token, il est désactivé de façon permanente.
Pour supprimer un token API
- Dans le Centre d’administration, cliquez sur Applications et intégrations (
) dans la barre latérale, puis sélectionnez API > API Zendesk.
- Sélectionnez le token dans la liste, puis cliquez sur Supprimer sur le côté droit.
Gestion de l’accès à l’API avec un token OAuth
Vous pouvez utiliser des tokens d’accès OAuth pour authentifier les demandes d’API. OAuth permet aux applications d’accéder aux données Zendesk de façon sécurisée sans avoir à stocker ni à utiliser les tokens API, qui sont des informations sensibles.
Vous ne pouvez pas créer de tokens d’accès OAuth directement dans le Centre d’administration comme vous le faites pour les tokens API. Vous devez d’abord créer un client OAuth dans le Centre d’administration, puis utiliser le client OAuth dans un flux d’autorisation OAuth défini pour créer un token d’accès OAuth.
Les tokens d’accès OAuth sont différents des tokens API. Consultez la section sur les différences entre les tokens API et les tokens d’accès sur developer.zendesk.com.
Cette section aborde les sujets suivants :
- Création d’un client OAuth
- Création d’un token d’accès avec un client OAuth
- Suppression des clients et des tokens OAuth
Pour savoir comment authentifier les demandes d’API avec un token d’accès OAuth, consultez la section sur les tokens d’accès OAuth sur developer.zendesk.com.
Création d’un client OAuth
Les clients OAuth vous permettent de créer des tokens d’accès OAuth servant à authentifier les demandes d’API. Les tokens d’accès OAuth sont différents des tokens API. Les tokens d’accès OAuth permettent aux applications d’accéder à l’API Zendesk de façon sécurisée sans avoir à stocker ni à utiliser les tokens API de vos utilisateurs Zendesk.
Pour créer un client OAuth
- Dans le Centre d’administration, cliquez sur Applications et intégrations (
) dans la barre latérale, puis sélectionnez API > API Zendesk.
- Sélectionnez l’onglet Clients OAuth.
- Pour créer un client, cliquez sur le bouton Ajouter un client OAuth et suivez les instructions que vous trouverez dans Enregistrement de votre application auprès de Zendesk.
- Pour supprimer un client, sélectionnez-le dans la liste, puis cliquez sur Supprimer sur le côté droit.
Utilisez ensuite le client OAuth pour créer un ou plusieurs tokens d’accès OAuth.
Création d’un token d’accès avec un client OAuth
Après avoir créé un client OAuth dans le Centre d’administration, vous pouvez l’utiliser avec un flux d’autorisation défini pour créer des tokens d’accès OAuth.
Vous pouvez aussi utiliser le client OAuth avec l’API pour créer des tokens d’accès sans flux d’autorisation. Vous pouvez utiliser un token API pour authentifier ces demandes d’API Consultez la section sur la création et l’utilisation des tokens d’accès OAuth avec l’API sur developer.zendesk.com.
Suppression des clients et des tokens OAuth
Vous pouvez supprimer un client OAuth pour désactiver tous les tokens d’accès créés avec ce client. Vous pouvez aussi révoquer les tokens d’accès individuellement.
Pour supprimer un client OAuth
- Dans le Centre d’administration, cliquez sur Applications et intégrations (
) dans la barre latérale, puis sélectionnez API > API Zendesk.
- Sélectionnez l’onglet Clients OAuth.
- Sélectionnez le client dans la liste, puis cliquez sur Supprimer sur le côté droit.
Pour révoquer un token d’accès spécifique
- Consultez la section sur la révocation des tokens d’accès sur developer.zendesk.com.
25 commentaire
Sid Bhambhani
I know this is an older thread, but just wanted to share with the community in case anyone's still looking for a solution to restricting the API permissions - https://www.unevu.com/ provides a good solution for this by means of defining rules for which endpoints can be access, and even which fields should be available on a particular endpoint.
0
Alejandro Sánchez
Hola,
No me aparece la opción de API pese a tener la suscripción Team en Aplicaciones e integraciones.
Me aparecen solo Integraciones (logs e integraciones) y Conexiones (Conexiones y Clientes OAuth).
0
Audrey Ann Cipriano
Hi Charles Eljay Cruz welcome to our Community!
You and your team may follow our guide here :)
Making requests to API
List Tickets
0
Charles Eljay Cruz
Hello. Our Information Security team plan to enable the Zendesk API to integrate external application. How can we accomplish this? Thank you!
0
SUbodh Singh
Hi Team,
I'm integrating Zendesk in my tool/application where we need the OAuth 2.0 process for authorization, I have gone through the official documentation of API reference for the same, but facing an issue.
Issue:
I have created an account on Zendesk and created the Oauth Client APP. when we are authorized with the same account it works fine. when we authorize another Zendesk account then it's not working getting an error (Invalid Authorization Request No such client)
here is URL for the reference:
https://{subdomain}.zendesk.com/oauth/authorizations/new?response_type=code&redirect_uri=http://localhost:49417/listen/zendesk&client_id=Cloudsocial_zendesk&scope=read+write
If possible, let's us help to connect with developers for a quick call.
1
Jed Hollander
Ivan Miquiabas thank you for confirming.
0
Ivan Miquiabas
Thanks for reaching out!
While we do know that having access to API can only be by an administrator as per this article you can actually restrict them on Explore access via the Custom roles, so that even though users has access to API, you still do have control on accessing certain reports in your Zendesk account.
Hope that helps!
0
Jed Hollander
Was this ever answered?
I want to give someone API Access to work on an integration but I do not want them to have access to reporting. Is this possible?
Thanks.
0
Joyce
Generating an API token can be done within Apps and integrations > APIs > Zendesk API in the Admin Center. Only the OAuth access tokens can be created via API. You check this article for more information: Creating and using OAuth access tokens with the API
0
rahul siddu
hi,
is it possible to generate a new api - token through API, using zendesk access token?
0
Vous connecter pour laisser un commentaire.