Citrix SD-WAN Orchestrator

Guide d’API pour Citrix SD-WAN Orchestrator

Pour accéder au guide de l’API du service Citrix SD-WAN Orchestrator sur l’interface utilisateur 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 qui exécute des API pour le compte de votre client, connectez-vous au compte Citrix Cloud du client à l’aide de l’option Changer de client ou obtenez l’authentification et les paramètres d’API pertinents auprès du client.

    Gestion des identités et des accès

    Créer un client sécurisé

  2. Donnez un nom à 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’identifiant et le secret et stockez-les 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é d’API de Citrix Cloud lorsque vous avez terminé d’utiliser les API.

    Identité et Secret

  3. Connectez-vous au service Citrix SD-WAN Orchestrator et cliquez sur  ? dans le coin supérieur droit de l’interface utilisateur, puis cliquez sur Guide des API.

    Icône API

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

    Icône API

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

  5. Sur la page API, accédez à auth-controller >/{cCId} /api/v1/logon > Try it out.

    Controller d'authentification

  6. À partir du service Swagger Spec Detailsde Citrix SD-WAN Orchestrator, copiez l’ identifiant Citrix Cloud et collez-le dans la zone de texte située sous l’ID utilisateur Citrix Cloud.

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

    Charge utile de l'API

  8. Copiez la valeur du jeton depuis la réponse du serveur.

    Réponse du serveur

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

    Autoriser

    clé API

Le processus d’autorisation est terminé et vous devez maintenant être en mesure d’accéder aux API du service Citrix SD-WAN Orchestrator et de les utiliser.

Guide d’API pour Citrix SD-WAN Orchestrator

Dans cet article