Zimun: Appointment Scheduling & Booking Software: API‑Leitfaden

Die API von Zimun: Appointment Scheduling & Booking Software ist für Teams gedacht, die Buchungen nahtlos in ihre eigenen Tools integrieren wollen. Nutze sie, um Live‑Verfügbarkeit zu zeigen, temporäre Holds zu setzen und Termine konfliktfrei zu bestätigen.

Für wen diese API gedacht ist

Wenn du eine Kunden‑App, ein Mitarbeiterportal oder ein internes Tool betreibst, hält dich die API mit Zimun: Appointment Scheduling & Booking Software synchron, während du das Erlebnis weiter selbst gestaltest.

Stell dir das als Termin‑Engine vor, die du überall einbetten kannst: Website, mobile App oder ein privates Admin‑Tool fürs Team.

Protokoll & Format

• HTTPS + JSON‑Antworten (UTF‑8).
• OAuth2‑Client‑Credentials‑Authentifizierung (RFC 6749 §4.4).
• Idempotente POST/PATCH mit Idempotency‑Key für sichere Wiederholungen.
• Paginierung über page_size/page_token mit { items, next_page_token }.
• ISO‑8601‑Zeitstempel mit Zeitzonen‑Offset.

Wie Authentifizierung funktioniert

1. Erstelle in Einstellungen → API Clients einen API‑Client, um client_id und client_secret zu erhalten.
2. Fordere ein Token von /oauth/token mit dem Client‑Credentials‑Grant an.
3. Rufe die API mit Authorization: Bearer <token> auf.

Tokens sind kurzlebig und auf deine Organisation beschränkt.

Scopes auf einen Blick

• org:read - Organisationsmetadaten
• availability:read - Slots und Feiertagsübersicht
• appointments:read - Termine auflisten/anzeigen
• appointments:write - holds, bestätigen, umbuchen, stornieren, webhooks

Basis-URL

https://api.zimun.online/api/v1

Typischer Buchungsablauf

1. Verfügbarkeit für einen Service oder ein Teammitglied anzeigen.
2. Erstelle einen 10‑Minuten‑Hold, wenn ein Nutzer einen Slot auswählt.
3. Bestätige den Termin mit Kundendaten - oder gib den Hold frei, wenn sie abbrechen.

Dieser Ablauf entspricht der öffentlichen Buchungsseite, sodass du dasselbe konfliktfreie Verhalten erhältst.

Schnellbeispiel (cURL)

Verwende dieses Beispiel, um die Verfügbarkeit der nächsten 7 Tage abzurufen. Ersetze service_id und dein Access‑Token.

curl -X GET \
  "https://api.zimun.online/api/v1/availability?service_id=s_123&days_ahead=7" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Für End‑to‑End‑Beispiele in Python, Node.js, Go und Rust siehe die API‑Referenzseite.

Typische Anwendungsfälle

• Eingebettete Buchung - Nutze die API, um eine eigene Termin‑UI in deiner App zu betreiben.
• CRM- / POS‑Sync - Übertrage bestätigte Termine in deine internen Tools oder dein Analytics‑System.
• Operations‑Dashboard - Frage Services, Personal und Ressourcen für eine Echtzeit‑Terminansicht ab.

User‑Stories

• Eine Klinik‑App zeigt verfügbare Therapeut:innen pro Service, setzt Holds, während ein Patient ein Formular ausfüllt, und bestätigt dann den Termin.
• Ein Studio synchronisiert Termine nachts per Pull in sein BI‑Dashboard.
• Ein SaaS‑Marktplatz bettet ein Buchungs‑Modal ein, das die Verfügbarkeits- und Konfliktregeln von Zimun: Appointment Scheduling & Booking Software nutzt.