Rubrique précédente: Documentation d'API détaillée

Rubrique suivante: Enregistrement de version ESX


Authentification

Avant de pouvoir utiliser les API de BFC, vous devez créer une session d'authentification. Pour créer une session, vous devez publier un nom d'utilisateur et un mot de passe dans la ressource de connexion pour la version d'API de BFC souhaitée. Si le nom d'utilisateur et le mot de passe sont valides, un ID de session est renvoyé et doit être transmis pour chaque appel d'API de BFC dans l'en-tête de l'autorisation. Les sessions restent valides pendant 30 minutes sans activité. Chaque demande envoyée à BFC réinitialise le délai d'expiration de la session, sauf si l'en-tête X-CA-FC-runningClock est inclus et est défini sur true. Cela peut s'avérer utile pour les clients qui disposent d'appels d'interrogation autonomes vers le BFC. Un client peut mettre fin à une session en publiant son ID dans la ressource de déconnexion.

Création d'une session
POST  BFC/1.0/login
En-têtes

Content-Type:application/json

Arguments

La charge utile est un objet JSON à deux champs : username et password.

username

Si le nom d'utilisateur n'est pas compatible avec un client hébergé, le client hébergé principal est supposé. Actuellement, le seul client hébergé disponible dans BFC est le client hébergé principal.

Par exemple, joe (ou core/joe)

password

Mot de passe correspondant au nom d'utilisateur.

Par exemple, MonMotDePasse

{"username":"joe","password":"MonMotDePasse"}
Résultats

La charge utile renvoyée est une chaîne JSON représentant l'ID de la session. Par exemple :

"2f9b84766cdacd376125c7d57aaf6aa7"
Fin d'une session
POST/BFC//logout 
En-têtes

Content-Type:application/json

Authorization:votre ID de session

Arguments

Votre ID de session