REST-API verwenden
Mit der REST-API können externe Tools Releases, Archive und Uploads lesen und Befehle an Bearcat senden. Sie verwendet die Adresse und den Port der Weboberfläche.
Endpunkte und Dokumentation
Abschnitt betitelt „Endpunkte und Dokumentation“| Pfad | Zweck |
|---|---|
/api/v1 |
API-Endpunkte |
/openapi/v1.json |
OpenAPI-Spezifikation |
/api/docs |
Interaktive Dokumentation |
Läuft Bearcat zum Beispiel unter http://localhost:5000, öffne http://localhost:5000/api/docs
oder lade die Spezifikation von http://localhost:5000/openapi/v1.json herunter.
Die API-Referenz listet ebenfalls die Endpunkte, Parameter und Schemas auf.
Authentifizierung
Abschnitt betitelt „Authentifizierung“Wer Bearcat erreichen kann, kann Daten über GET-Endpunkte lesen. Betreibe Bearcat in einem privaten
Netzwerk oder beschränke den Zugriff mit einem Reverse Proxy mit Basic Auth oder einem VPN.
Befehle (POST) brauchen einen API-Schlüssel im Header X-Api-Key.
Einrichtung und Beispiele findest du unter Bearcat mit externen Tools steuern.
Client generieren
Abschnitt betitelt „Client generieren“Mit Kiota oder NSwag
kannst du einen typisierten Client generieren. Verwende dafür /openapi/v1.json deiner Bearcat-Installation.