Zum Inhalt springen

Offene Schnittstelle

Schlüssel prüfen

GET/api/ext/v1/whoami

Kein besonderes RechtErfolg 200

Beim Start aufrufen und prüfen, ob der Schlüssel das darf, was vorgesehen ist. Das ist billiger, als beim ersten Schreibversuch auf 403 zu laufen.

Felder der Antwort
FeldTypBedeutung
tenantobject
tenant.slugstringKurzname des Betriebs, bleibt gleich.
tenant.namestringName des Betriebs.
tenant.countrystringLand des Betriebs, ISO 3166-1 alpha-2.
tenant.currencystringWährung aller Beträge dieses Betriebs.
keyobject
key.idstringKennung des Schlüssels, der vordere Teil des Tokens.
key.namestringName, den der Admin dem Schlüssel gegeben hat. Steht als Handelnder im Journal.
scopesstring[]Rechte, die dieser Schlüssel trägt.
Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/whoami" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"tenant": {
"slug": "talstation",
"name": "Skiverleih Talstation",
"country": "AT",
"currency": "EUR"
},
"key": {
"id": "01a1c478-a2b4-734d-827a-e37fd88d51e7",
"name": "Hotel Alpenhof"
},
"scopes": [
"day.view",
"booking.edit"
]
}

Ein Schlüssel mit allen wählbaren Rechten sieht so aus:

Antwort200OK

{
"tenant": {
"slug": "talstation",
"name": "Skiverleih Talstation",
"country": "AT",
"currency": "EUR"
},
"key": {
"id": "01a1c478-9d5a-77fb-996c-5f6a991935ea",
"name": "Kassensystem"
},
"scopes": [
"day.view",
"job.complete",
"job.order",
"booking.view",
"booking.edit",
"booking.create",
"booking.cancel",
"course.view",
"accommodation.edit",
"price.view",
"settings.edit",
"stats.view"
]
}
  • Beim Start: Prüfen Sie scopes gegen das, was Ihr Programm vorhat, und brechen Sie mit einer klaren Meldung ab, wenn ein Recht fehlt.
  • Bei der Einrichtung: tenant.name zeigt dem Menschen, der den Schlüssel einträgt, dass er den richtigen Betrieb erwischt hat.
  • Als Lebenszeichen: Der Aufruf liest nichts aus den Buchungen des Betriebs und ist damit der billigste Weg, Erreichbarkeit und Gültigkeit des Schlüssels zu prüfen.

Die Währung in tenant.currency gilt für alle Beträge dieses Betriebs.