| Suite | Team, Growth, Professional, Enterprise ou Enterprise Plus |
| Support | Team, Professional ou Enterprise |
Résumé IA vérifié ◀▼
Gérez l’accès à l’API de votre compte Zendesk en générant, modifiant, désactivant, réactivant et supprimant des tokens API. Avec les éditions Enterprise, vous pouvez aussi consulter le journal des audits pour prendre connaissance des activités liées aux tokens.
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 adresse e-mail 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.
Cet article inclut les sections suivantes :
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 > Tokens API.
Une liste des tokens API s’affiche.
- Cliquez sur Ajouter un token API.
- (facultatif) Saisissez une description pour le token.
- Cliquez sur Enregistrer pour générer le token.
Le token est généré et s’affiche.
-
Copiez le token et collez-le à un endroit sûr.
Remarque – Une fois que vous cliquez sur Enregistrer pour fermer cette fenêtre, le token complet ne s’affichera plus jamais.
- Cliquez à nouveau sur Enregistrer pour retourner à la liste des tokens API Zendesk.
Si vous cliquez sur le token pour le rouvrir, vous en voyez une version tronquée.
Modification d’un token API
Vous pouvez modifier un token API pour mettre sa description à jour.
- Dans le Centre d’administration, cliquez sur Applications et intégrations () dans la barre latérale, puis sélectionnez API > Tokens API.
- Trouvez le token à modifier.
- Cliquez sur l’icône du menu des options (
) en regard du token et sélectionnez Modifier. - Saisissez une nouvelle description pour le token, puis cliquez sur Enregistrer.
Désactivation et réactivation d’un token API
Il peut arriver que vous vouliez désactiver un token pour vous assurer qu’il n’a pas été compromis ou pour savoir comment il est utilisé sans le supprimer. Les tokens désactivés peuvent être réactivés.
Pour désactiver un token API
- Dans le Centre d’administration, cliquez sur Applications et intégrations () dans la barre latérale, puis sélectionnez API > Tokens API.
- Recherchez le token que vous voulez désactiver.
- Cliquez sur l’icône du menu des options () en regard du token et sélectionnez Désactiver.
- Dans la boîte de dialogue de confirmation, cliquez sur Désactiver.
Le statut du token change immédiatement. Dès que vous désactivez un token, les appels API qui utilisent ce token échouent.
- Dans le Centre d’administration, cliquez sur Applications et intégrations () dans la barre latérale, puis sélectionnez API > Tokens API.
- Recherchez le token que vous voulez réactiver.
- Cliquez sur l’icône du menu des options () en regard du token et sélectionnez Réactiver.
- Dans la boîte de dialogue de confirmation, cliquez sur Réactiver.
Le statut du token change et passe de Désactivé à Actif. La réactivation d’un token restaure sa capacité à authentifier les demandes d’API.
Suppression d’un token API
- Dans le Centre d’administration, cliquez sur Applications et intégrations () dans la barre latérale, puis sélectionnez API > Tokens API.
- Recherchez le token que vous voulez supprimer et vérifiez que son statut est bien Désactivé.
- Cliquez sur l’icône du menu des options () en regard du token et sélectionnez Supprimer.
- Dans la boîte de dialogue de confirmation, cliquez sur Supprimer.
Consultation des journaux des audits pour les tokens API (Enterprise)
Dans les éditions Enterprise, le journal des audits enregistre les activités associées à un token API, notamment ses dates de création, de désactivation ou de réactivation.
- Dans le Centre d’administration, cliquez sur Applications et intégrations () dans la barre latérale, puis sélectionnez API > Tokens API.
- Recherchez le token dans la liste.
- Cliquez sur l’icône du menu des options () en regard du token et sélectionnez Consulter le journal des audits.
Le journal des audits s’ouvre avec un filtre appliqué pour le token API que vous avez sélectionné. Le journal des audits affiche les activités associées au token.
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
Se connecter pour laisser un commentaire.