L’application doit d’abord diriger l’utilisateur vers la page d’autorisation de Zendesk. La page demande à l’utilisateur d’autoriser votre application à accéder à Zendesk en votre nom. Lorsque l’utilisateur a pris sa décision, Zendesk renvoie le choix et d’autres éléments d’information à votre application.

Pour diriger l’utilisateur vers la page d’autorisation de Zendesk

Ajoutez un lien ou un bouton dans votre application pour diriger l’utilisateur vers l’URL suivante :

https://{子域名}.zendesk.com/oauth/authorizations/new

où{subdomain}est votre sous-domaine Zendesk. Vous pouvez utiliser une requête POST ou GET. Incluez les paramètres suivants :

• response_type- obligatoire. Zendesk renvoie un code d’autorisation dans la réponse ; vous devez donc spécifiercodecomme type de réponse. Exemple :response_type=code.
• redirect_uri- obligatoire. L’URL que Zendesk doit utiliser pour envoyer la décision de l’utilisation pour accorder l’accès à votre application. L’URL doit être absolue (pas relative). Elle doit en outre être sécurisée (https), sauf si vous utilisez localhost ou 127.0.0.1.
• client_id- obligatoire. L’identifiant unique que vous avez obtenu lorsque vous avez enregistré votre application auprès de Zendesk. Voir la section ci-dessus.
• scope- obligatoire. Liste séparée par des espaces des valeurs qui contrôlent l’accès aux ressources Zendesk. Vous pouvez demander un accès de typeread,writeouimpersonateà toutes les ressources ou à des ressources spécifiques. ConsultezDéfinition de la portée.
• state——经纱arbitraire incluse在响应de禅desk une fois que l’utilisateur a décidé ou non d’octroyer l’accès. Vous pouvez utiliser le paramètre pour vous protéger contre les attaques intersite (CSRF). Lors d’une attaque de type CSRF, l’utilisateur final est incité à cliquer sur un lien qui lance une action dans une application Web où l’utilisateur est toujours authentifié. Pour se protéger contre ce type d’attaque, ajoutez une valeur au paramètrestateet validez-la lorsqu’elle revient.

Veillez à coder les paramètres dans l’URL.

Exemple de requête GET

https://{子域名}.zendesk.com/oauth/authorizations/new?response_type=code&redirect_uri={your_redirect_url}&client_id={your_unique_identifier}&scope=read%20write

La page d’autorisation de Zendesk s’ouvre dans le navigateur de l’utilisateur final. Une fois que l’utilisateur a pris sa décision, Zendesk envoie la décision à l’URL de redirection que vous avez spécifiée dans la demande.

Votre application doit traiter la réponse de Zendesk, qui lui indique ce qu’a décidé l’utilisateur. Les informations se trouvent dans les paramètres d’URL de l’URL de redirection.

Si l’utilisateur a décidé d’accorder l’accès à l’application, l’URL de redirection contient un code d’autorisation. Exemple :

{redirect_url}?code=7xqwtlf3rrdj8uyeb1yf

Le code d’autorisation n’est valable que 120 secondes.

Si l’utilisateur a décidé de ne pas accorder l’accès à l’application, l’URL de redirection contient les paramètreserroreterror_descriptionqui informent l’application que l’utilisateur a refusé l’accès :

{redirect_url}?error=access_denied&error_description=The+end-user+or+authorization+server+denied+the+request

Utilisez ces valeurs pour contrôler le flux de votre application. Si l’URL contient le paramètrecode, obtenez un token d’accès auprès de Zendesk, comme décrit dans la section suivante. Il s’agit du token à inclure dans les appels API à Zendesk.

Si votre application a reçu un code d’autorisation de Zendesk en réponse à l’utilisateur octroyant l’accès, votre application peut l’échanger contre un token d’accès. Pour obtenir le token d’accès, lancez une requête POST au point final suivant :

https://{子域名}.zendesk.com/oauth/tokens

Incluez les paramètres suivants obligatoires dans la requête :

• grant_type——specifiez« authorization_code »comme valeur.
• code- utilisez le code d’autorisation que vous avez reçu de Zendesk après octroi de l’accès par l’utilisateur.
• client_id- utilisez l’identifiant unique spécifié dans un client OAuth dans l’interface d’administration Support (Admin>Canaux>API>Clients OAuth). ConsultezEnregistrement de votre application auprès de Zendesk.
• secret- utilisez le secret spécifié dans un client OAuth dans l’interface d’administration Support (Admin>Canaux>API>Clients OAuth). ConsultezEnregistrement de votre application auprès de Zendesk.
• redirect_uri- la même URL de redirection que celle de l’étape 1. À des fins d’identification uniquement.
• scope- consultezDéfinition de la portée.

La requête doit être dirigée sur un site https et les paramètres doivent être au format JSON.

Utilisation de curl

curl https://{subdomain}.zendesk.com/oauth/tokens \ -H "Content-Type: application/json" \ -d '{"grant_type": "authorization_code", "code": "{your_code}", "client_id": "{your_client_id}", "client_secret": "{your_client_secret}", "redirect_uri": "{your_redirect_url}", "scope": "read" }' \ -X POST

Exemple de réponse

Status: 200 OK { "access_token": "gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo", "token_type": "bearer", "scope":"read" }

L’application peut utiliser le token d’accès pour effectuer des appels d’API. Incluez le token dans un en-tête d’autorisation HTTP avec la demande, comme suit :

Authorization: Bearer {a_valid_access_token}

Par exemple, une requête curl pour répertorier des tickets ressemblerait à ce qui suit :

curl https://{subdomain}.zendesk.com/api/v2/tickets.json \ -H "Authorization: Bearer gErypPlm4dOVgGRvA1ZzMH5MQ3nLo8bo"