Offene Schnittstelle
Schlüssel prüfen
Betrieb, Schlüssel und Rechte
Abschnitt betitelt „Betrieb, Schlüssel und Rechte“GET/api/ext/v1/whoami
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
| Feld | Typ | Bedeutung |
|---|---|---|
tenant | object | |
tenant.slug | string | Kurzname des Betriebs, bleibt gleich. |
tenant.name | string | Name des Betriebs. |
tenant.country | string | Land des Betriebs, ISO 3166-1 alpha-2. |
tenant.currency | string | Währung aller Beträge dieses Betriebs. |
key | object | |
key.id | string | Kennung des Schlüssels, der vordere Teil des Tokens. |
key.name | string | Name, den der Admin dem Schlüssel gegeben hat. Steht als Handelnder im Journal. |
scopes | string[] | Rechte, die dieser Schlüssel trägt. |
curl "https://skirent.sumware.at/api/ext/v1/whoami" \ -H "Authorization: Bearer $SKI4ME_KEY"const res = await fetch("https://skirent.sumware.at/api/ext/v1/whoami", { headers: { Authorization: `Bearer ${process.env.SKI4ME_KEY}`, },});
const data = await res.json();if (!res.ok) throw new Error(`${data.error.code}: ${data.error.hint}`);console.log(data);import osimport requests
res = requests.get( "https://skirent.sumware.at/api/ext/v1/whoami", headers={"Authorization": f"Bearer {os.environ['SKI4ME_KEY']}"}, timeout=10,)data = res.json()if not res.ok: raise RuntimeError(f"{data['error']['code']}: {data['error']['hint']}")print(data)<?php
$ch = curl_init('https://skirent.sumware.at/api/ext/v1/whoami');curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_TIMEOUT => 10, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('SKI4ME_KEY'), ],]);$body = curl_exec($ch);$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$data = json_decode($body, true);if ($status >= 400) { throw new RuntimeException($data['error']['code'] . ': ' . $data['error']['hint']);}print_r($data);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" ]}Verwendung
Abschnitt betitelt „Verwendung“- Beim Start: Prüfen Sie
scopesgegen das, was Ihr Programm vorhat, und brechen Sie mit einer klaren Meldung ab, wenn ein Recht fehlt. - Bei der Einrichtung:
tenant.namezeigt 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.