API
Dienste und Spezifikationen
Alle API-Dienste mit Swagger und OpenAPI
Jeder Fachbereich hat einen eigenen API-Dienst unter der Basis-URL. Zu jedem Dienst gibt es eine Swagger-Oberfläche zum Ausprobieren und eine OpenAPI-Spezifikation zum Einlesen:
- Swagger UI:
https://api.dev.sergo-test.de/<dienst>/swagger - OpenAPI (JSON):
https://api.dev.sergo-test.de/<dienst>/openapi/v1.json
Ersetze <dienst> durch den Pfad aus der Tabelle. Beispiel: Die Swagger-Oberfläche des Geräte-Dienstes erreichst du unter https://api.dev.sergo-test.de/device/swagger.
Dienste
| Dienst | Pfad | Inhalt |
|---|---|---|
| Konten | /account | Benutzer, Kontakte und Unternehmen (Tenants) |
| Verträge | /contract | Verträge und Laufzeiten |
| Produkte | /product | Produktkatalog und Bestellungen |
| Rechnungen | /invoice | Rechnungen und Abrechnungskonten |
| Geräte | /device | Geräteverwaltung |
| Domains | /domain | Domains und DNS |
| Hosting | /hosting | Websites und Webhosting |
| Dateien | /file | Dateien und Dokumente |
| Microsoft 365 | /microsoft365 | Microsoft-365-Lizenzen und Nutzer |
| Google Workspace | /google | Google-Workspace-Integration |
| Software | /software | Software-Katalog |
| DNS-Filter | /dns-filter | DNS-Filter |
| Netzwerk | /network | Netzwerkgeräte |
Welche Endpunkte ein Dienst genau anbietet, steht in seiner OpenAPI-Spezifikation. Für den Zugriff brauchst du einen Token, siehe Authentifizierung.