Petla Partner API

Die Buchungs-Schnittstelle zwischen Petla und Ihrem Praxisverwaltungssystem. Ein Tierhalter bucht auf Petla, der Termin landet im Kalender der Praxis — in Ihrem System, in dem die Praxis ohnehin arbeitet.

Der eine Satz, der alles erklärt

Petla besitzt den Kalender der Praxis nicht — und will das auch nicht. Ihr System veröffentlicht, wann die Praxis buchbar ist. Petla bietet diese Zeiten Tierhaltern an und schickt gebuchte Termine zurück. Jede Entwurfsentscheidung in dieser Dokumentation folgt daraus.

Was die Integration leistet

Sie bringt Nachfrage. Petla betreibt den Tierarztfinder und die App für Tierhalter. Die Termine, die dabei entstehen, kommen zu einem erheblichen Teil von Haltern, die noch nicht zum Kundenstamm der Praxis gehören.

Konkret:

Und was sie ausdrücklich nicht tut

Die zwei Flüsse

Es sind zwei, beide sind nötig, und sie laufen in entgegengesetzte Richtungen. Wer macht den Aufruf, ist eine getrennte Frage — siehe unten.

PMS → PetlaVerfügbarkeit. Wann ist die Praxis buchbar? Ohne diesen Fluss kann Petla nur Zeiten verkaufen, die es sich ausgedacht hat.
Petla → PMSTermine. Ein Halter hat gebucht. Ihr System schreibt den Termin und bestätigt — oder lehnt begründet ab.
Der Punkt, der die meisten Integrationen entscheidet

Ihr System muss keine eingehenden HTTPS-Anfragen entgegennehmen können. Alles Verpflichtende in dieser Schnittstelle ist ein Aufruf, den Ihr System an Petla richtet — auch das Abholen neuer Termine, das über Polling läuft. Ein Praxisrechner hinter einem Router kann die vollständige Integration betreiben. Wer eingehende Anfragen annehmen kann, bekommt zusätzlich die Slot-Reservierung (siehe Termine empfangen).

Was Sie mindestens implementieren müssen

Jede Funktion trägt eine Konformitätsstufe. Sie erklären mit PUT /capabilities, was Ihr System kann; Petla schaltet pro Praxis genau so viel frei. Was Ihre Verbindung nicht unterstützt, wird der Praxis als „Ihre Praxissoftware unterstützt das nicht“ angezeigt — nie als leeres Ergebnis.

StufeBedeutung
CoreMuss implementiert werden. Ohne diese Funktionen gibt es keine Integration.
ExtendedSollte implementiert werden. Petla hat für jede dieser Funktionen ein definiertes Verhalten, wenn sie fehlt.
ImplementierungsspezifischKann implementiert werden. Wird pro Partner abgestimmt.

Core sind vier Dinge: die Fähigkeiten erklären, Verfügbarkeit veröffentlichen, den Ereignis-Strom abrufen und jeden empfangenen Termin bestätigen.

Wo Sie weiterlesen

Hinweis

Diese Dokumentation ist ein Entwurf und wird gegen die Antworten der ersten beiden Partner finalisiert — nicht gegen die eines einzigen. Wenn Ihr System eine der Annahmen hier nicht erfüllt, ist das genau die Rückmeldung, die wir jetzt brauchen: partner@petla.app.

Normativ ist die englische Spezifikation. Bei Abweichungen zwischen dieser Seite und der Referenz gilt die Referenz.