Zum Inhalt springen

Einstieg

Schnellstart

Ein Schlüssel und drei Aufrufe: prüfen, was der Schlüssel darf, die Tour eines Tages lesen, eine Lieferung als erledigt melden.

  1. Im Portal als Admin des Betriebs anmelden und Schnittstelle öffnen.
  2. Einen Namen vergeben, etwa den des Systems, das ruft. Er steht später im Journal neben jeder Änderung.
  3. Die Rechte einzeln wählen. Für diesen Schnellstart: day.view und job.complete.
  4. Anlegen. Das Geheimnis erscheint genau einmal. Kopieren Sie es jetzt; danach zeigt es niemand mehr, auch der Betreiber nicht.

Der Schlüssel besteht aus einer Kennung und einem Geheimnis, getrennt durch einen Punkt. Legen Sie beides zusammen in eine Umgebungsvariable:

export SKI4ME_KEY=“0193f2a7-4c31-7b8e-9d02-5f1a2b3c4d5e.skr_9dLp2Qx7Vn4Rk0TzYb8HsWc3Mf6JgA1uEe5oNiXqPl”

Dieser Schlüssel ist erfunden und öffnet nichts. Wie er aufgebaut ist und was der Server davon speichert, steht unter Schlüssel und Rechte.

whoami nennt Betrieb, Namen des Schlüssels und seine Rechte. Rufen Sie es beim Start Ihres Programms auf: das ist billiger, als beim ersten Schreibversuch auf 403 zu laufen.

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"
]
}

Alle Lieferungen und Abholungen eines Tages in der Reihenfolge der Tour, je mit Haus, Gast, Zimmern und Status. Das ist der Zustellstatus, nach dem ein Hotel fragt.

Terminal-Fenster
curl "https://skirent.sumware.at/api/ext/v1/days/2026-12-27" \
-H "Authorization: Bearer $SKI4ME_KEY"

Antwort200OK

{
"date": "2026-12-27",
"jobs": [
{
"id": 3,
"kind": "delivery",
"onDate": "2026-12-27",
"sortOrder": null,
"status": "open",
"accommodation": {
"id": 2,
"name": "Hotel Alpenhof",
"street": "Dorfstraße 12",
"zip": "5999",
"city": "Bergdorf"
},
"booking": {
"ref": "SB-261114-WWNP",
"status": "confirmed",
"guestName": "Martin Berger",
"phone": "+49 000 0000002",
"rooms": [
"204",
"205"
],
"persons": 3,
"pickupAtDepot": false
},
"note": null,
"skipReason": null,
"doneAt": null,
"doneBy": null,
"doneOnDate": null,
"earlyDone": false
}
],
"counts": {
"delivery": 2,
"pickup": 0,
"open": 2,
"done": 0,
"skipped": 0
}
}

jobs zeigt 1 von 2 Einträgen.

Mit der id eines Auftrags aus der Tour setzen Sie ihn auf erledigt. Der Zustand der Buchung folgt von selbst: geliefert, abgeholt, und erst wenn beide Aufträge erledigt sind, geschlossen.

Terminal-Fenster
curl -X PATCH "https://skirent.sumware.at/api/ext/v1/jobs/3" \
-H "Authorization: Bearer $SKI4ME_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "done",
"note": "Im Skiraum abgestellt, Fach 204."
}'

Antwort200OK

{
"jobId": 3,
"status": "done",
"doneAt": "2026-12-27T08:12:46.278Z",
"doneBy": "Kassensystem",
"doneOnDate": "2026-12-27",
"earlyDone": false,
"skipReason": null,
"swapStatus": null,
"note": "Im Skiraum abgestellt, Fach 204."
}

Jeder Fehler hat dieselbe Form, und das Feld hint nennt den nächsten Schritt. So sieht es aus, wenn dem Schlüssel ein Recht fehlt:

Antwort403Forbidden

{
"error": {
"code": "forbidden",
"message": "Diesem Schlüssel fehlt: booking.view.",
"status": 403,
"hint": "Im Portal unter Einstellungen, Schnittstelle, einen Schlüssel mit diesem Recht anlegen.",
"documentation_url": "https://skirent.sumware.at/api/"
}
}

Mehr dazu unter Fehler.