System API

Beschreibung

Diese Seite dokumentiert die System API von Squeeze. Mit dieser können Mandanten und das System verwaltet werden.

URL

Die URL unter welcher Squeeze erreichbar ist, in Kombination mit dem folgenden Path: /api/system/v1/dist/,
Beispielsweise https://test.staging.squeeze.one/api/system/v1/dist/.
So erreichen Sie die im Swagger UI, welche die Verwendung unserer System API vereinfacht.

Absicherung

Die System API ist mit einer einfachen Basis-Authentifizierung abgesichert. Die Zugangsdaten, ein Benutzername und ein Passwort, befinden sich in der docker-compose.yml ihrer Squeeze Installation oder sollten Ihnen mitgeteilt worden sein.
Ist dies nicht der Fall kontaktieren Sie uns bitte, damit wir Ihnen diese zukommen lassen können.

System API Anfrage authentifizieren

Swagger UI

In der Swagger UI finden Sie einen Button mit dem Namen "Authorize". Durch die Verwendung von diesem Element öffnet sich ein Modaler Dialog, in dem Sie Ihre Nutzerdaten (Benutzername und Passwort) hinterlegen können.
Suchen Sie hierfür nach der "HTTP Basic Authentication"-Methode, welche, im Regelfall, als oberste Methode aufgeführt wird.

Selbst erstellte Anfrage

Sie müssen Ihre Zugangsdaten mit der Base64-Methode enkodieren, wobei das Format der zu enkodierenden Zeichenkette Username:Passwort lautet.
So ergibt beispielsweise der Username system und das Passwort system die nach Base64-Methode enkodierte Zeichenkette c3lzdGVtOnN5c3RlbQ==.
Der Präfix "Basic" wird der enkodierten Zeichenkette beigefügt und als eine Zeichenkette dem Header, mit dem Key "Authorization", beigefügt; Beispiel: Authorization: Basic c3lzdGVtOnN5c3RlbQ==.

Wenn Sie beispielsweise alle Tenants aufgeführt haben möchten, als Teil Ihrer selbst erstellten Anfrage, sähe Ihre Anfrage wie folgt aus (den Beispielen dieser Seite folgend, unter Verwendung von cURL):

curl --location 'http://test.staging.squeeze.one/api/system/v1/tenants' --header 'Authorization: Basic c3lzdGVtOnN5c3RlbQ=='