Frisbii Media basiert auf dem API-First-Prinzip. Alle Funktionen finden sich in der Frisbii Media API Dokumentation:
Stage API-Dokumentation für Stage-System: Frisbii Media API v3
Public API-Dokumentation für Live-System: Frisbii Media API v3
Hinweis: Sobald wir Änderungen an der Frisbii Media API vornehmen - seien es Fehlerbehebungen, Verbesserungen oder neue Funktionen - wird die API-Dokumentation zeitgleich aktualisiert, um stets aktuelle Informationen bereitzustellen.
Folgende Authentifizierung nutzt die Frisbii Media API:
Security Scheme Type: API Key
Header Parameter Name: X-plenigo-token
Für die Ausführung der entsprechenden Endpunkte werden Zugriffsrechte benötigt, die im Merchant Backend bei der Erstellung des API-Zugangs-Tokens definiert werden müssen. Welche Zugriffsrechte benötigt werden, befindet sich in jedem Kapitel in der API Dokumentation.
Die benötigten API-Token können im Merchant Backend im jeweiligen Mandanten erstellt, gepflegt und kopiert werden.>> API-Zugangs-Token
Anfragen
Die HTTP-Methoden (z. B. GET, POST) bestimmen die Art der Operation an der Ressource. Mit Abfrageparametern können zusätzliche Optionen für die GET-Anfragen bereitgestellt werden. POST-Parameter liefern die Daten für Schreiboperationen wie Erstellung, Änderung der Ressource(n).
Status Codes
Folgende Status Codes werden in der Frisbii Media API verwendet:
Code 2xx - zeigen einen erfolgreichen Aufruf an.
Codes 4xx - zeigen ein clientseitiges Problem mit dem Aufruf an.
Codes 5xx - zeigen ein serverseitiges Problem mit dem Aufruf an.
Antworten
Die Antwort der API erfolgt im JSON-Format. Derzeit unterstützt die Frisbii Media API kein anderes Antwortformat.