Surveillance des API basées sur OAuth 2.0

L’objectif principal de la première tâche Get Token est d’obtenir un jeton d’accès pour que l’application accède à l’API Service. En cas de succès, le jeton d’accès peut être récupéré à partir de la réponse api de service et utilisé dans les demandes d’API ultérieures. En outre, la tâche vérifie l’échange d’un code d’autorisation d’application pour le jeton d’accès. En cas d’erreur, l’alerte sera générée pour l’appareil.

Pour créer un appareil, cliquez sur Nouvel appareil sur la page Gestionnaire d’appareil et sélectionnez la tâche HTTP/S.

Url

Pour configurer la tâche, nous devons générer la demande de jetons d’accès au serveur d’autorisation. Dans le champ URL, spécifiez l’URL du serveur d’autorisation API dans le format https://authorization-server.com/oauth/authorize. L’URL exacte dépend du service auquel vous vous connectez.

Vérification SSL/Certificat

Activer les vérifications des certificats SSL.

Données de type de demande et de publication

Les paramètres d’authentification du client(id client et secret client), rediriger URI, et le code d’autorisation doivent être fournis dans la demande au serveur d’autorisation. Utilisons la méthode POST (le champ Type de demande) pour envoyer les détails de l’application et le code.

Dans le domaine des données postales, nous devons spécifier les attributs suivants de l’organisme de demande :

• 
  client_id
  – votre identifiant de demande, émis lors de la première inscription de votre demande au serveur d’autorisation.
• 
  client_secret
  – émis lors de la première inscription de votre demande au serveur d’autorisation.
• 
  code
  – le code d’autorisation reçu du serveur d’autorisation.
• 
  grant_type
  – doit être mis à “authorization_code«.
• 
  redirect_uri
  – l’URL doit correspondre à l’URL de redirection que vous avez précédemment enregistrée avec l’application.

À la suite de l’exécution de la tâche, nous recevrons une réponse JSON avec le jeton d’accès du serveur d’autorisation dans l’organe de réponse.

Validation du contenu

Pour vous assurer que la réponse du serveur renvoie le jeton d’accès et le jeton de rafraîchissement (est utilisé si le jeton d’accès expire), spécifiez les mots clés suivants :

• access_token
• refresh_token

Pour configurer d’autres champs de tâches, si nécessaire, consultez ajouter/modifier une tâche HTTP(S).

Une fois la configuration terminée, cliquez sur Créer l’appareil et passez à l’étape suivante pour implémenter un appel API à l’aide du jeton d’accès.

Lorsque la réponse API avec le jeton d’accès est reçue à la suite de l’exécution get token task, nous devons extraire le jeton pour appeler l’API Service. Par exemple, nous voulons récupérer la liste d’utilisateurs du service surveillé en demandant un point de terminaison /utilisateurs.

Tout d’abord, créez un script pour extraire le jeton du corps de réponse Get Token Task à une variable. Par exemple, le script suivant transmet le type de jeton et de jeton de la réponse d’autorisation de base dans la variable
TokenAuthorization
:

string access_token;
string token_type;
string TokenAuthorization;

// get the authorization response from the first task
string json = (Tasks["Get Token"] as Http).body["//*"];

//convert response to the comma separated strings
string[] comas = json.Split(new Char[] { ',' });

// get the access token
int start1 = comas[0].IndexOf(":") + 2;
int length1 = comas[0].Length - start1 - 1;
access_token = comas[0].Substring(start1, length1); 

// get the token type
int start2 = comas[1].IndexOf(":") + 2;
int length2 = comas[1].Length - start2 - 1;
token_type = comas[1].Substring(start2, length2);

// set the TokenAuthorization variable to specify in the data request header 
TokenAuthorization = token_type + " " + access_token;

Pour ajouter une nouvelle tâche au dispositif de surveillance API configuré à la première étape :

1. Sur la page Gestionnaire d’appareil, cliquez sur le bouton d’action de la ligne périphérique.
2. Sur le menu d’action, sélectionnez Ajouter la tâche.

Url

Dans le champ URL, spécifiez la demande URI de votre ressource de service dont vous avez besoin pour extraire des données.

Vérification SSL/Certificat

Activer les vérifications des certificats SSL.

Type de demande

Sélectionnez le type de demande GET.

OAuth 2.0 nécessite un type de jeton d’accès et de jeton à passer dans l’en-tête d’autorisation de la demande HTTP GET, mais vous pouvez également le fournir sous la forme d’une chaîne de requête GET ou d’un paramètre de corps POST.

En-têtes

Ajoutez l’en-tête avec le nom

de l’en-tête autorisation et la valeur TokenAuthorization.

Pour convertir la variable
TokenAuthorization
en dynamique, cliquez sur l’icône de vitesse dans le champ de valeur, et dans le dialogue Modifier la valeur, sélectionnez Dynamique.

Le champ de valeur dynamique sera marqué avec les supports.

Préparer le script

Ajoutez le script à passer dans le jeton d’accès.

Validation du contenu

Pour vérifier les données retournées avec la réponse de service, vous pouvez également spécifier les mots clés correspondants. Par exemple, plusieurs noms d’utilisateur que vous vous attendiez à récupérer du service.

Pour configurer d’autres champs de tâches, voir Ajouter/Modifier une tâche HTTP(S).