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. Trouvez le bouton Autoriser en haut à droite de la page API d’Orchestrator. Si le cadenas est ouvert, cela signifie que vous n’êtes pas autorisé.

   Image 1. Bouton Autoriser

2. Sélectionnez Autoriser. La fenêtre Autorisations disponibles s'affiche.

   Remarque :

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

   Figure 2. Autorisations disponibles

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. Sélectionnez Autoriser. Une nouvelle fenêtre s'affiche pour confirmer que vous avez été autorisé.

5. Une fois que vous avez terminé, sélectionnez Fermer ou X pour fermer la fenêtre Autorisations disponibles. Le bouton Autoriser affiche un verrou fermé signifiant que vous ê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  3. Ressource d'API non autorisée

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 4. En-tête d'autorisation du porteur

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. Trouvez le bouton Autoriser en haut à droite de la page API d’Orchestrator. Le cadenas devrait être fermé.

   Figure 5. Bouton Autoriser

2. Sélectionnez Autoriser et, sur la page Autorisations disponibles qui s'affiche, sélectionnez Déconnexion pour révoquer le jeton expiré.

   Figure 6. Autorisations disponibles

3. Fermez la fenêtre Autorisations disponibles en sélectionnant Fermer ou X, puis obtenez un jeton d'accès comme décrit dans la section Obtention d'un jeton d'accès.

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é.