Integrationshandbücher › BFC API-Referenzhandbuch › URL-Konstruktion › API-Gruppierung und Versionskontrolle

API-Gruppierung und Versionskontrolle

Die BFC-APIs wird mithilfe des Anwendungspräfixes "BFC" in der URL gruppiert. Das Anwendungspräfix folgt direkt hinter dem Host in der URL.

Alle APIs unterstützen die Versionskontrolle. API-Versionsnummern sind relativ zur API selbst, nicht relativ zum BFC. Daher muss sich die API-Version nicht ändern, wenn sich die BFC-Version ändert. Eine API-Version hat zwei Teile, die höchste und die niedrigste Versionsnummer. Es können mehrere Versionen der APIs gleichzeitig vorhanden sein. Die Verfahren, wenn für Versionen der Support eingestellt wird, werden zu einem späteren Zeitpunkt bekannt gegeben, die Rückwärtskompatibilität innerhalb eines Releases bleibt jedoch stets bestehen, in dem sich nur die API-Versionsnummer ändert. Die Nutzlastdatensätze können sich zwischen zwei Versionen ändern. Die URL, die die API-Versionen angibt, kennzeichnet auch die Datensatzversion. Der Datensatz selbst enthält keine Versionsnummer. Allerdings kann bei einigen APIs die Version im Namen des Datensatzes eingeschlossen sein.

Die BFC-APIs werden zu Beginn in Version 3.5.0 des BFC zur Verfügung gestellt. Die Anfangsversion der API ist 1.0. Ein Client fordert eine API-Version an, indem er eine Sitzung mit einem ausdrücklichen Versionsanmeldungs-URI aufbaut. Jede BFC-Version unterstützt einen ausdrücklichen Versionsanmeldungs-URI für jede unterstützte API-Version. Nur die zur Anmeldung verwendeten URIs enthalten ausdrückliche Versionsnummern.

Beispiel URLs für die Anfangsversion:

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/...

Angenommen eine zukünftige Version des BFC enthält eine Änderung an den Grid-APIs, die Unterstützung der API Version 1.0 soll aber beibehalten werden, können in der neuen Version die folgenden URLs unterstützt werden:

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/1.1/login
https://<bfchost>:8443/BFC/grids/...

Beachten Sie, dass Version 1.1 ebenfalls neue APIs enthalten kann, die in Version 1.0 nicht vorhanden waren. In diesem Fall können neue URLs eingeführt werden:

https://<bfchost>:8443/BFC/servers/...

Ein Client, der sich beim URI der Version 1.0 angemeldet hat, hätte keinen Zugriff auf den URI des neuen Servers. Zugriffsanforderungen würden den HTTP-Fehler 404 zurückgeben.