API
Übersicht
Die SERGO API nutzen
Über die SERGO API automatisierst du Aufgaben und verbindest eigene Systeme mit der Plattform. Es ist eine REST-API über HTTPS, Anfragen und Antworten laufen in JSON.
So funktioniert die API
- REST über HTTPS, mit JSON in Anfrage und Antwort.
- Token pro Anfrage: Jede Anfrage schickt einen Zugriffstoken im
Authorization-Header (Bearer). Der Zugang für Kunden wird gerade fertiggestellt, siehe Authentifizierung. - Ein Token, ein Unternehmen: Ein Token gilt für genau ein Unternehmen (Tenant). Ein Aufruf sieht nur die Daten dieses Unternehmens.
- Ein Dienst je Fachbereich: Geräte, Domains, Rechnungen und so weiter haben jeweils einen eigenen API-Dienst, siehe Dienste und Spezifikationen.
Basis-URL
Alle Dienste laufen unter einer gemeinsamen Basis-URL pro Umgebung:
- Dev:
https://api.dev.sergo-test.de
Dahinter folgen der Dienst und der Endpunkt, zum Beispiel https://api.dev.sergo-test.de/device/v1/....
Interaktiv ausprobieren
Jeder Dienst stellt eine Swagger-Oberfläche und eine OpenAPI-Spezifikation bereit:
- Swagger UI:
https://api.dev.sergo-test.de/<dienst>/swagger - OpenAPI (JSON):
https://api.dev.sergo-test.de/<dienst>/openapi/v1.json
Welche Dienste es gibt, steht unter Dienste und Spezifikationen.