Einführung

Erste Schritte mit der Afi Platform API

Die Afi-API ist nach REST-Prinzipien aufgebaut und verwendet vorhersehbare, ressourcenorientierte URLs. Die API akzeptiert JSON-codierte Anforderungstexte (Request Bodies), gibt JSON-codierte Antworten zurück und verwendet standardmäßige HTTP-Statuscodes, Authentifizierungsverfahren und HTTP-Methoden.

Information

Sie können die OpenAPI-Spezifikation für die Afi Platform API hier herunterladen.

Anforderungen an die Afi-API werden mit den API-Schlüsseln einer Anwendung authentifiziert. Die Anwendung (Application) ist ein zentrales Konzept für Integrationen mit Afi. Sie ermöglicht den API-Zugriff auf Ressourcen und Konfigurationen in den Organisationen und Mandanten, in denen sie installiert ist.

Die Afi-API ist versioniert: Inkompatible Änderungen führen zu einer neuen API-Version, während kleinere Änderungen und neue Funktionen ohne Änderung der API-Version veröffentlicht werden.