Vorheriges Thema: Detaillierte API-Dokumentation

Nächstes Thema: ESX-Versionsdatensatz


Authentifizierung

Um die BFC-APIs verwenden zu können, müssen Sie eine Authentifizierungssitzung erstellen. Sie erstellen eine Sitzung, indem Sie in der Anmeldungsressource einen Benutzernamen und ein Kennwort für die gewünschte Version der BFC-API angeben. Wenn der Benutzername und das Kennwort gültig sind, wird eine Sitzungs-ID zurückgegeben, die für jeden Aufruf der BFC-API im Autorisierungs-Header übergeben werden muss. Ohne Aktivität bleiben Sitzungen 30 Minuten lang gültig. Durch jede Anforderung beim BFC wird das Sitzungszeitlimit zurückgesetzt, außer der Header X-CA-FC-runningClock ist vorhanden und hat den Wert true. Dies ist nützlich für Clients mit unbeaufsichtigten Abfrageanrufen am BFC. Ein Client kann eine Sitzung beenden, indem die Sitzungs-ID in der Abmelderessource angegeben wird.

Erstellen einer Sitzung
POST BFC/1.0/login
Header

Content-Type:application/json

Argumente

Die Nutzlast ist ein JSON-Objekt mit zwei Feldern: username und password.

username

Wenn der Benutzername nicht durch einen Mandanten qualifiziert ist, wird der Kernmandant angenommen. Gegenwärtig ist im BFC nur der Kernmandant verfügbar,

z. B. joe (oder core/joe)

password

Das Kennwort für den Benutzer,

z. B. MyPassword.

{"username":"joe","password":"MyPassword"}
Ergebnisse

Die zurückgegebene Nutzlast ist eine JSON-Zeichenfolge, die die Sitzungs-ID angibt. Zum Beispiel:

"2f9b84766cdacd376125c7d57aaf6aa7"
Beenden einer Sitzung
POST/BFC//logout 
Header

Content-Type:application/json

Authorization:your session id

Argumente

Ihre Sitzungs-ID