Guide de l’API SD-WAN Orchestrator

Pour accéder au Guide de l’API SD-WAN Orchestrator sur l’interface utilisateur de Swagger, vous devez vous authentifier à l’aide d’une clé d’API.

La procédure suivante fournit des instructions sur la génération d’une clé API et son utilisation pour l’authentification.

  1. Connectez-vous à votre compte Citrix Cloud et accédez àGestion des identités et des accès > Accès aux API.

Remarque Si vous êtes un partenaire exécutant des API pour le compte de votre client, connectez-vous au compte Citrix Cloud du client à l’aide de l’option Modifier le client ou obtenir les paramètres d’authentification et d’API pertinents auprès du client.

Gestion des identités et des accès

Créer un client sécurisé

  1. Indiquez un nom pour votre client sécurisé et cliquez sur Créer un client. Un ID et une clé secrète sont générés. Utilisez l’ID et le secret pour vous authentifier lorsque vous utilisez des API pour gérer votre réseau.

Remarque Téléchargez l’ID et le secret et stockez-le en toute sécurité. Vous ne pouvez pas accéder au secret après avoir fermé la fenêtre.

Identité et Secret

Remarque Pour des raisons de sécurité, il est conseillé de supprimer les entrées de clé API de Citrix Cloud lorsque vous avez terminé d’utiliser les API.

Identité et Secret

  1. Connectez-vous au SD-WAN Orchestrator et cliquez sur l’icône API dans le coin supérieur droit de l’interface utilisateur.

Icône API

Les détails de la spécification Swagger sont affichés.

Icône API

  1. Cliquez sur l’URL de la spécification Swagger pour accéder au guide de l’API.

  2. Dans la page API, accédez à auth-controller > /{ccId}/api/v1/logon > Try it out.

Controller d'authentification

  1. Dans SD-WAN Orchestrator Swagger Spec Details, copiez l’ID Citrix Cloud et collez-le dans la zone de texte sous l’ID utilisateur Citrix Cloud.

  2. De même, copiez et collez l’ID client, Client secret et Citrix Cloud ID dans les champs de charge utile respectifs, puis cliquez sur Exécuter.

Charge utile de l'API

  1. Copiez la valeur du jeton à partir de la réponse du serveur.

Réponse du serveur

  1. Cliquez sur Autoriser en haut de la page API et collez la valeur du jeton dans le champ Valeur. Cliquez sur Autoriser.

Autoriser

Clé API

Cela termine le processus d’autorisation et vous devez désormais pouvoir accéder aux API SD-WAN Orchestrator et les utiliser.

Guide de l’API SD-WAN Orchestrator