Health-API
Eine minimale REST-API ermöglicht es Ihnen, Statusinformationen über Ihre Zeta-Uploader-Instanz abrufen.
Der Funktionsumfang dieser Schnittstelle ist zurzeit relativ kompakt und wird zukünftig erweitert werden.
Authentifizierung konfigurieren
Um die API-Schnittstelle aufrufen zu können, benötigen Sie entsprechende Zugangsdaten.
Diese Zugangsdaten sind pro Benutzer in der Administrationsoberfläche definierbar und einsehbar:
- Benutzer kann auf die API zugreifen — Kontrollkästchen, das steuert, ob mit den dem Benutzer zugeordneten API-Zugangsdaten ein API-Aufruf stattfinden kann.
- API-Schlüssel — Der Schlüssel, der beim Aufruf eines API-Endpunkts verwendet werden muss.
- API-Geheimnis — Der zweite Teil zum Schlüssel, der ebenfalls beim Aufruf eines Endpunkts verwendet werden muss.
API-Endpunkt aufrufen
Die REST-API von Zeta Uploader verwendet Basic Authentication.
Verwenden Sie beliebige Clients, um entsprechende Aufrufe durchzuführen.
Ein beispielhafter Aufruf eines API-Endpunkts mit dem Befehlszeilenprogramm cURL sieht beispielsweise so aus:
curl -v -u U54803545:P39262783 https://example.org/api/v1/health/status
In diesem Beispiel ist U54803545
der API-Schlüssel und
P39262783
das API-Geheimnis.
Der Aufruf gibt im Erfolgsfall einen HTTP-Statuscode 200 zurück und eine JSON-Antwort mit den entsprechenden Daten.
Verfügbare API-Endpunkte
Zurzeit gibt es folgende API-Endpunkte:
/api/v1/health/status
— Liefert die letzten Fehlermeldungen, die in Zeta Uploader auftraten./api/v1/health/ping
— Liefert im Erfolgsfall eine kurze Antwort. Kann verwendet werden um eine generelle Ereichbarkeit des Dienstes zu überprüfen.