Performance Cloud VMware - Accédez à l’ « API » ou interface applicative de programmation vCloud


Référence

https://blogs.vmware.com/cloudprovider/2017/10/getting-started-vcloud-director-9-0-api-part-1.htm

Définitions

Pour faciliter la lecture et pour faire correspondre les captures d’écrans, l’acronyme anglais « API » pour « Application Programming Interface» sera utilisé au lieu de la traduction française « interface applicative de programmation ».

Notes

Dans les étapes ci-dessous, nous utilisons le logiciel Postman mais vous pouvez utiliser n'importe quelle plate-forme d'API compatible.

Sherweb ne fournira aucun type de support pour l'utilisation de l'outil mentionné ou de tout autre logiciel tiers. Veuillez consulter le site Web d'assistance du fournisseur du logiciel pour toute demande d'assistance.

Prérequis

Avoir installé le logiciel Postman

Étape 1 - Créer une nouvelle collection et s'authentifier auprès de l'API

  • Dans Postman, créez une nouvelle collection.



  • Donnez un nom à la nouvelle collection et changez le type d'autorisation pour «Basic Auth ».

    Une image contenant texte 
Description générée automatiquement
     
  • Entrez le nom d'utilisateur et le mot de passe et cliquez sur « Save ».

    Le nom d'utilisateur à entrer est [nom d'utilisateur Performance Cloud VMware] + [@] + [organisation Performance Cloud VMware]
    Exemple: john@domaine.com@organisation

    Une image contenant texte 
Description générée automatiquement
     
  • Créer une nouvelle demande (« Add a request »).



  • Exécutez la requête suivante :

    GET https://performancecloud-vdc.sherweb.com/api/versions

    Une image contenant texte 
Description générée automatiquement 
  • Confirmez que vous êtes correctement authentifié avec la valeur d'autorisation dans l'onglet « Headers ».

    Une image contenant texte 
Description générée automatiquement

Étape 2 - Découvrez les versions d'API prises en charge

Avec la requête précédemment effectuée, validez les versions d'API prises en charge pour vous assurer que vos requêtes d’API sont pris en charge.
 

Une image contenant table

Description générée automatiquement

Étape 3 - Établir une session

Dans la section « Headers » , créez une nouvelle clé comme celle-ci :

KEY: Accept

VALUE: Application/*+xml;version=35.2

Remarque : la version doit être la dernière version disponible de l'étape 2
 

Une image contenant texte

Description générée automatiquement

 

Créer une session sur vCloud Director à l'aide de l'authentification de base


Remarque : en utilisant cette méthode avec la valeur « x-vcloud-authorization », la session sera réinitialisée après quelques heures.


Exécutez la requête suivante pour confirmer que vous avez créé avec succès une session sur vCloud Director :
  

POST https://performancecloud-vdc.sherweb.com/api/sessions
 
 

Vous devriez recevoir une réponse « 200 OK » pour confirmer la réussite de celle-ci.
 

Une image contenant texte

Description générée automatiquement

 

Prenez note de la valeur « x-vcloud-authorization »
 

Une image contenant texte, capture d’écran, intérieur

Description générée automatiquement

 
Créez une nouvelle clé dans la section « Headers » comme ceci :

KEY: x-vcloud-authorization

VALUE: valeur de l'étape précédente
 


Créer une session sur vCloud Director à l'aide d'un « Bearer Token »

Dans l'onglet Tests, saisissez les lignes suivantes et cliquez sur « Send » :

 

var bearer = postman.getResponseHeader("X-VMWARE-VCLOUD-ACCESS-TOKEN")

pm.environment.set("X-VMWARE-VCLOUD-ACCESS-TOKEN",bearer)
 

Une image contenant table

Description générée automatiquement

 

Obtenez la valeur “X-VMWARE-VCLOUD-ACCESS-TOKEN”.

 

Une image contenant texte

Description générée automatiquement



Accédez à l'onglet « Authorization ». Remplacez le type d'autorisation « Inherit from parent » par « Bearer Token ».

Entrez la valeur de l'étape précédente et cliquez sur « Save ».

Une image contenant texte

Description générée automatiquement

 

Tester la requête pour obtenir les informations sur l'organisation

 
Exécutez la requête suivante :

GET https://performancecloud-vdc.sherweb.com/api/org

Le résultat devrait ressembler à ceci :
 

Une image contenant texte

Description générée automatiquement

Étape 4 - Effectuer des requêtes

Voici quelques requêtes à titre d'exemple.
 

Explorateur d’API

Il existe également l'outil nommé Explorateur d’API qui peut être activé à la demande.
L' « API » est documentée avec « Swagger » et peut être visualisée et exécutée directement depuis le portail.

Veuillez contacter notre équipe d'assistance Cloud pour demander la fonctionnalité Explorateur d’API si vous le souhaitez.

Une fois activé, vous aurez accès à un nouveau rôle dans le portail: « Organization Administrator + API Access »


Les membres de ce nouveau rôle auront accès à l'outil Explorateur d’API.

 
Une image contenant texte

Description générée automatiquement 


 Une image contenant texte

Description générée automatiquement