API

Eine API für Doctolib-Termine

Docal stellt eine REST-API bereit, die die Doctolib-Agenden eines Praktikers ausliest und darin echte Patiententermine anlegt. Sie richtet sich an Softwareanbieter, Voicebots und Integratoren, die in Doctolib einen Termin buchen möchten, ohne die Benutzeroberfläche zu verwenden.

Was die API ermöglicht

Agenden

Die Agenden des Kontos und ihre Kennungen auflisten.

Terminarten

Die Terminarten auflisten, mit ihrer Dauer und ihren Buchungsbedingungen. Der Parameter agendaId beschränkt die Liste auf die Terminarten, die auf einer bestimmten Agenda tatsächlich nutzbar sind, mit ihrer auf dieser Agenda geltenden Dauer. Ohne ihn enthält die Liste auch Terminarten, die diese Agenda nicht nutzen kann.

Verfügbarkeiten

Die freien Zeitfenster einer Agenda für eine Terminart und einen Datumsbereich auslesen.

Option auf ein Zeitfenster

Ein Zeitfenster vorübergehend reservieren, bis die Bestätigung mit dem Patienten erfolgt.

Terminerstellung

Einen echten Patiententermin anlegen, wobei die bestehende Patientenakte gesucht oder bei Bedarf neu angelegt wird.

Ändern und Stornieren

Einen bereits gebuchten Termin verschieben oder stornieren.

Voraussetzungen

Ein Docal-Praxiskonto mit dem verbundenen Doctolib-Konto des Praktikers sowie einer laufenden Testphase oder der API-Option.
Google Kalender ist für die Nutzung der API nicht erforderlich: Ein Partner, der nur die API nutzt, kann starten, ohne ihn jemals zu verbinden.
Der von Docal auf Anfrage für das Konto aktivierte Patiententermin-Modus.

Es gibt keinen API-Zugang ohne Praxiskonto: Die API handelt stets im Namen eines identifizierten Praktikers, auf dessen eigenen Agenden.

Testphase und Zugangsbedingungen

Die API ist während der 7-tägigen Testphase inklusive, mit einem auf 500 Aufrufe begrenzten Kontingent, das für eine vollständige Integration ausreicht. Nach der Testphase ist der API-Zugang eine eigene, vom Synchronisierungsabonnement unabhängige monatliche Option, die nach Zahlung aktiviert wird. Schreiben Sie uns, um das zu besprechen.

Obergrenzen

Durchsatz, monatliche Kontingente und Verhalten bei Überschreitung

Durchsatz	5 Aufrufe pro Sekunde und Konto
Monatliches Kontingent, bezahltes Konto	5.000 Aufrufe pro Kalendermonat
Monatliches Kontingent während der Testphase	500 Aufrufe
Überschreitung	Antwort 429 mit einem Retry-After-Header, kein Aufruf wird einzeln berechnet

Die Obergrenzen gelten für das Konto, nicht für den Schlüssel: Das Erzeugen mehrerer Schlüssel vervielfacht den Durchsatz nicht.

Idempotenz

Die Terminerstellung akzeptiert einen Idempotenz-Schlüssel. Geht Ihr Aufruf unterwegs verloren und wiederholen Sie ihn mit demselben Schlüssel, liefert Docal den bereits angelegten Termin zurück, statt einen zweiten anzulegen. So wird sichergestellt, dass ein Netzwerkausfall keinen doppelten Eintrag in der Agenda des Praktikers erzeugt.

Fehler

Alle Fehler haben dieselbe Form, { "error": { "code": "...", "message": "..." } }.

Code	Status	Bedeutung
INVALID_API_KEY	401	Schlüssel fehlt, ist unbekannt oder wurde widerrufen.
APPOINTMENT_MODE_DISABLED	403	Der Terminmodus ist für dieses Konto nicht aktiviert.
API_ACCESS_REQUIRED	403	Weder eine laufende Testphase noch eine aktive API-Option.
RATE_LIMIT_EXCEEDED	429	Durchsatz pro Sekunde überschritten.
MONTHLY_QUOTA_EXCEEDED	429	Monatliches Kontingent aufgebraucht.

Personenbezogene Daten

Die API arbeitet mit den Daten des Praktikers, die bei Doctolib und bei Google gehostet werden. Docal speichert die Terminarten nicht in der Datenbank. Eine Auftragsverarbeitungsvereinbarung ist auf Anfrage für Praktiker und Partner erhältlich.

Bereit, die API zu integrieren?

API-Zugang anfragen

Schreiben Sie uns in zwei Zeilen, was Sie bauen möchten und wie viele Praktiker betroffen sind.

Die ausführliche Referenz, Endpoint für Endpoint, finden Sie in Ihrem Docal-Konto unter Einstellungen, dann API.