Eine API (englisch: Application Programming Interface, deutsch: Programmierschnittstelle) ist ein Programmteil, der von einem Softwaresystem anderen Programmen zur Anbindung zur Verfügung gestellt wird. Laut Wikipedia ist eine API ein standardisierter Weg, mit dem externe Software auf die Funktionen und Daten eines Systems zugreifen kann.
Was eine REST-API im Terminbuchungssystem leisten kann
- Freie Termine abfragen: Externe Anwendungen lesen aus, welche Tage und Uhrzeiten buchbar sind.
- Termine erstellen: Buchungen können programmatisch aus anderen Anwendungen heraus ausgelöst werden.
- Nutzer anlegen: Kundenkonten werden im Zuge der Buchung über die API erstellt.
- Formularfelder abfragen: Welche Angaben eine Buchung benötigt, liefert die Schnittstelle selbst.
- Webhooks empfangen: Ereignisse wie neue Buchungen oder Absagen werden über Webhooks in Echtzeit an externe Systeme übermittelt.
- Integration in CRM-Systeme: Kundendaten aus Buchungen können automatisch in Kundenmanagementsysteme übernommen werden.
Typische Merkmale
Moderne Web-APIs arbeiten mit HTTP-Anfragen und JSON als Datenformat. Statt eines Passworts wird ein Token mitgeschickt, das der Betreiber im Administrationsbereich erzeugt und jederzeit erneuern kann. Üblich sind außerdem eine Begrenzung der Anfragen pro Minute sowie der Betrieb zwischen Servern: Das Token gehört auf den eigenen Server und nicht in eine Website oder App.
Die API von Appointmind
Appointmind stellt eine REST-API bereit, die den kompletten Buchungsablauf in sechs Aufrufen abbildet:
| Aufruf | Zweck |
|---|---|
GET /schedules | Verfügbare Terminkalender auflisten |
GET /reasons | Termingründe eines Kalenders mit Beschreibung und Dauer |
GET /days | Tage, an denen ein Termin frei ist |
GET /slots | Freie Uhrzeiten eines Tages |
GET /forms | Formularfelder, die für die Buchung benötigt werden |
POST /bookings | Termin buchen |
Die Anmeldung erfolgt per Bearer-Token, das im Administrationsbereich unter Konfiguration → API erzeugt wird; standardmäßig sind 300 Anfragen pro Minute möglich. Eine Übersicht finden Sie auf der Seite Modul „API (Schnittstelle)“, eine Schritt-für-Schritt-Anleitung unter REST-API einrichten und nutzen.