Autorisation des appels d'API dans Swagger

Accéder à Swagger

Si vous utilisez Swagger pour tester notre API, il suffit de vous connecter à Orchestrator dans un onglet distinct.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain} /swagger/ui/index#/.

Obtention d'un jeton d'accès

Pour autoriser les appels d'API via l'interface utilisateur Swagger dans votre instance Orchestrator, procédez comme suit :

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). If the lock is open, you are unauthorized.

   

2. Cliquez sur Autoriser. La fenêtre Autorisations disponibles s’affiche.

   Remarque :

   Nous prenons actuellement en charge un schéma d’autorisation appelé OAuth2.

   

3. Toutes les étendues sont présélectionnées de sorte que vous puissiez expérimenter avec tous les points de terminaison dans l'API Orchestrator. Désactivez-les si vous souhaitez restreindre l'accès à certaines API.

4. Cliquez sur Autoriser. Une nouvelle fenêtre s’affiche, confirmant votre autorisation.

5. Une fois terminé, cliquez sur Fermer ou sur X pour fermer la fenêtre Autorisations disponibles . Le bouton Autoriser affiche un cadenas fermé, ce qui signifie que vous y êtes autorisé.

Envoi de requêtes

Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes sur les ressources de l'API Orchestrator comme suit :

1. Développez une ressource d'API Orchestrator avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.

   Figure 1. Unauthorized API resource

   

2. Dans la fenêtre de la méthode développée, sélectionnez Essayer.

3. Spécifiez les valeurs des paramètres si nécessaire.

4. Sélectionnez Exécuter. La demande est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.

   Figure 2. Bearer authorization header

   

Génération d'un nouveau jeton d'accès

Lorsque le jeton d'accès expire, vous recevez une réponse 401: You are not authenticated! . L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton d'accès a expiré. Lorsque cela se produit, vous devez invalider le jeton expiré et générer un nouveau jeton d'accès :

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed.

   

2. Cliquez sur Autoriser et, sur la page Autorisations disponibles affichée, cliquez sur Déconnexion pour révoquer le jeton expiré.

   

3. Close the Available authorizations window by clicking Close or X and then obtain an access token as described on the Obtaining an access token section.

Révoquer l’accès

Lorsque vous avez terminé de travailler avec l'interface utilisateur Swagger, vous devez invalider le jeton d'accès que vous avez utilisé :

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed, meaning you are authorized.
2. Cliquez sur Autoriser et, sur la page Autorisations disponibles affichée, cliquez sur Déconnexion.
3. Fermez la fenêtre Autorisations disponibles en cliquant sur Fermer ou X. Le bouton Autoriser affiche un verrou ouvert signifiant que vous n'êtes pas autorisé.