API compatible Zendesk

Beaucoup d’équipes ont leurs propres systèmes qui parlent à l’API Zendesk : services internes utilisant les SDK officiels, outils de back-office, widgets FAQ sur d’autres sites. ChaosDesk répond à ces requêtes sous /zd/api/v2 avec les mêmes formats de requête et de réponse : seuls l’URL de base et le token d’API changent.

Les écritures de tickets passent par le circuit normal des tickets : un audit par requête, les déclencheurs et SLA s’exécutent, et l’auteur de l’audit est le propriétaire du token.

Basculer un client

1. Créez un token d’API pour l’utilisateur d’intégration dans Admin Center, Integrations, API tokens, avec le scope write.
2. Faites pointer le client vers votre espace de travail :

Client	Réglage
HTTP simple	URL de base https://yourcompany.chaosdesk.io/zd/api/v2
C# ZendeskApi.Client	Sous-domaine yourcompany.chaosdesk.io/zd, nom d’utilisateur {email}/token, le token ChaosDesk
C# ZendeskApi_v2	new ZendeskApi("https://yourcompany.chaosdesk.io/zd/api/v2", email, token)
PHP zendesk_api_client_php	$client->setApiBasePath('zd/api/v2/') et l’hôte de votre espace de travail
Lecteurs du centre d’aide	URL de base https://yourcompany.chaosdesk.io/zd

3. Authentifiez-vous comme avant : Basic {email}/token:{token}, Authorization: Bearer {token} ou identifiants client OAuth sur POST /zd/oauth/tokens avec client_id = l’e-mail du propriétaire du token et client_secret = le token. L’authentification par mot de passe n’est pas prise en charge.

Chaque chemin .json répond aussi sans .json. Les liens de la forme {BaseUrl}agent/tickets/{id} redirigent vers le ticket dans l’espace agent.

Ids

Les enregistrements importés gardent leurs ids Zendesk : numéros de ticket et ids d’utilisateurs, d’organisations, de groupes et du centre d’aide. Les enregistrements créés dans ChaosDesk reçoivent de nouveaux ids au-dessus du plus élevé importé.

Endpoints

Domaine	Endpoints
Tickets	GET/POST tickets, GET/PUT/DELETE tickets/{id}, GET tickets/show_many, PUT tickets/update_many, DELETE tickets/destroy_many, GET tickets/count, GET tickets?external_id=
Commentaires et audits	GET tickets/{id}/comments, GET tickets/{id}/audits, GET tickets/{id}/audits/{audit_id}
Tags	GET/POST/PUT/DELETE tickets/{id}/tags
Téléversements	POST uploads?filename= (le token joint les fichiers au commentaire suivant)
Jobs	GET job_statuses/{id} pour les mises à jour et suppressions en masse
Recherche	GET search, GET search/count, avec la syntaxe de recherche Zendesk
Export incrémental	GET incremental/tickets/cursor, GET incremental/users/cursor et les variantes temporelles
Utilisateurs	GET/POST users, GET users/{id}, GET users/me, POST users/create_or_update, GET users/search
Organisations, groupes	GET organizations, GET organizations/{id}, GET groups, GET groups/{id}
Centre d’aide (public)	GET help_center/{locale}/sections, .../sections/{id}/articles, .../articles/{id}, GET help_center/articles/search

Les opérations en masse renvoient un job, comme dans Zendesk. Les mises à jour concurrentes avec safe_update renvoient 409.

Quelle stabilité

Les formats de cette page sont figés : nous ne faisons qu’ajouter des endpoints et des champs, et nous ne changeons jamais une réponse qu’un client écrit pour Zendesk analyse. Rien n’est retiré avec moins de 12 mois de préavis. Voir versions et dépréciation.

Ce qui ne bascule pas avec une URL de base

Les intégrations que vous n’avez pas écrites vous-même et qui sont figées sur *.zendesk.com (par exemple l’app Zendesk pour Zapier, le connecteur Zendesk de Fivetran ou les SDK mobiles Zendesk) ne peuvent pas être redirigées vers ChaosDesk. Utilisez plutôt l’API REST, les webhooks ou le messenger. Voir quitter Zendesk.

Zendesk est une marque de Zendesk, Inc. ChaosDesk n’est ni affilié à Zendesk, Inc., ni approuvé ou sponsorisé par elle ; l’API compatible existe pour l’interopérabilité avec vos propres logiciels.