Autorisation des appels d'API dans Swagger

Accéder à Swagger

Pour accéder à l’API Swagger d’Orchestrator, ajoutez /swagger/index.html à l’URL d’Orchestrator. Par exemple, https://{yourDomain}/swagger/index.html.

L’API qui s’affiche dans Swagger dépend directement de l’instance Orchestrator que vous utilisez. Pour effectuer facilement des requêtes directement depuis Swagger, connectez-vous à Orchestrator dans un autre onglet.

Obtenir un jeton d’accès

Pour autoriser les appels d’API via l’interface utilisateur Swagger pour les services Orchestrator, effectuez les étapes suivantes :

1. Recherchez le bouton Autoriser dans le coin supérieur droit de la page API d'Orchestrator. Si le cadenas est ouvert, cela signifie que vous n’êtes pas autorisé.
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é.
2. Dans la fenêtre de la méthode développée, cliquez sur Essayer.
3. Spécifiez les valeurs des paramètres si nécessaire.
4. Cliquez sur Exécuter. La requête est exécutée. Un en-tête d'autorisation de porteur est automatiquement utilisé pour vos demandes.

Générer 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. Recherchez le bouton Autoriser dans le coin supérieur droit de la page API d'Orchestrator. La serrure doit être fermée.
2. Cliquez sur Autoriser et sur la page Autorisations disponibles affichée, cliquez sur Déconnexion pour révoquer le jeton expiré.
3. Fermez la fenêtre Autorisations disponibles (Available authorizations) en cliquant sur Fermer (Close) ou sur X, puis obtenez un jeton d'accès comme décrit dans la section Obtention d'un jeton d'accès (Obtaining an access token).

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. Trouvez le bouton Autoriser en haut à droite de la page API d’Orchestrator. Le cadenas devrait être fermé, ce qui signifie que vous êtes autorisé.
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é.