Le lien Aide dans le panneau de gauche permet d'accéder à la documentation d'aide du produit ainsi qu'à la documentation de l'API. Les utilisateurs qui ont un accès à l'API pourront voir le lien "API docs".
Toute la documentation API est au format Swagger. Pour plus de détails sur l'API CE, reportez-vous à la Documentation Swagger de l'API CE.
Autoriser dans la documentation de l'API
Avant d’essayer une API depuis la documentation de l’API, autorisez-vous avec vos identifiants Cloud Exchange. Vous pouvez vous authentifier avec votre nom d'utilisateur et votre mot de passe Cloud Exchange, ou avec un jeton API. Chaque appel API que vous exécutez dispose des autorisations du compte avec lequel vous vous authentifiez.
- Pour vous autoriser avec un nom d’utilisateur et un mot de passe, utilisez un utilisateur Cloud Exchange local. Si vous vous connectez à Cloud Exchange avec SSO, autorisez plutôt avec un jeton API.
- Un utilisateur New doit se connecter à Cloud Exchange et changer le mot de passe par défaut avant de pouvoir autoriser dans les documents API.
Autoriser avec un nom d'utilisateur et un mot de passe
- Cliquez sur Help au bas du panneau gauche et sélectionnez API docs. Les documents de l’API s’ouvrent dans un New onglet du navigateur.
- Cliquez sur Authorize en haut à droite de la page.
- Dans la boîte de dialogue Autorisations disponibles, allez à la section OAuth2PasswordBearer (OAuth2, password) et saisissez vos identifiants :
- Username: Le nom d’utilisateur que vous utilisez pour vous connecter à Cloud Exchange.
- Password: Le mot de passe de cet utilisateur.
- Dans Scopes, sélectionnez les scopes dont vous avez besoin. Gardez tous les scopes non cochés pour autoriser toutes les permissions de votre compte. Notez que si vous sélectionnez un scope que votre compte n'a pas, l'autorisation échouera.
- Cliquer sur Authorize. La section affiche Autorisé, et les icônes de cadenas à côté des terminaux apparaissent fermées.
Important
Les tentatives infructueuses dans la documentation de l'API sont prises en compte pour le verrouillage de la connexion de votre utilisateur. Après cinq tentatives infructueuses, vous ne pouvez pas vous connecter à Cloud Exchange ou à la documentation de l'API tant que le délai indiqué dans le message d'erreur n'est pas écoulé.
- Cliquez sur Close.
- Développez le point de terminaison que vous souhaitez appeler et cliquez sur Try it out.
- Saisissez les paramètres et cliquez sur Execute. Le résultat apparaît sous Responses.
L'autorisation dure 2 heures. Après cela, les appels API renvoient Impossible de valider les identifiants. Pour continuer, cliquez sur Authorize, cliquez sur Logout, et autorisez à nouveau.
Autoriser avec un jeton d'API
À partir de Cloud Exchange v7.0.0, vous pouvez également autoriser dans la documentation de l’API avec l’ID client et le secret client d’un jeton API. Pour créer un jeton, consultez Jetons API.
- Dans la documentation de l'API, cliquez sur Authorize en haut à droite de la page.
- Accédez à la section OAuth2PasswordBearer (OAuth2, clientCredentials) et saisissez les détails du jeton :
- Client ID: L'identifiant client du jeton API.
- Client Secret: Le secret client que vous avez copié lors de la création du jeton.
- Sous Scopes, sélectionnez les portées dont vous avez besoin, ou gardez toutes les portées effacées pour utiliser toutes les autorisations du jeton.
- Cliquez sur Authorize, puis cliquez sur Close. Vous pouvez maintenant tester les points de terminaison comme décrit dans la section précédente.
