Authentification
Authentifiez les requêtes API avec un token d'API personnel, en lecture ou en écriture.
Traduit pour votre confort. Le code, les noms de champs et la référence de l'API restent en anglais. Version anglaise
Chaque requête API est authentifiée par un token d’API. Un token agit comme le membre de l’équipe qui le possède : il voit et modifie exactement ce que cette personne peut voir et modifier dans l’espace agent, avec en plus la limite du scope du token.
Créer un token
- Ouvrez Admin Center, Integrations, API tokens.
- Choisissez New token, donnez-lui un nom qui dit ce qui l’utilise (par exemple « Billing sync ») et choisissez un scope.
- Copiez le token. Il commence par
desk_et n’est affiché qu’une fois.
| Scope | Autorise |
|---|---|
read | Requêtes GET uniquement |
write | Toutes les méthodes : GET, POST, PUT, PATCH, DELETE |
Créez un token distinct pour chaque intégration, détenu si possible par un utilisateur d’intégration dédié. Le révoquer n’affecte alors que cette intégration.
Envoyer le token
GET /api/tickets HTTP/1.1
Host: yourcompany.chaosdesk.io
Authorization: Bearer desk_xxxxxxxxxxxxxxxxxxxx
Accept: application/json
Les réponses sont en JSON (application/json) ou JSON-LD (application/ld+json) selon l’en-tête Accept. Les mises à jour partielles utilisent PATCH avec Content-Type: application/merge-patch+json.
Erreurs
| Statut | Signification |
|---|---|
401 | Token absent, invalide, expiré ou révoqué |
402 | La fonctionnalité ne fait pas partie de votre offre (plan_required) |
403 | Le propriétaire du token n’a pas le droit, ou un token read a tenté d’écrire |
422 | Échec de validation ; le corps liste les champs |
429 | Limite de débit atteinte, voir les limites de débit |
Les erreurs utilisent les problem details RFC 9457 (application/problem+json).
API compatible Zendesk
L’API compatible Zendesk accepte les mêmes tokens avec les modes d’authentification Zendesk : Basic auth {email}/token:{token}, bearer token ou identifiants client OAuth.