Partner API Schnellstart

Die Partner API 1.9.0 verwendet JSON über HTTPS. Beginnen Sie in der Sandbox und verwenden Sie ausschließlich synthetische Testdaten. API-Schlüssel werden über den vereinbarten Partner-Onboarding-Prozess bereitgestellt und gehören nie in Browser, mobile Apps, URLs oder Logs.

Erste Anfrage

Setzen Sie den Schlüssel serverseitig im Header X-API-Key. Das folgende Beispiel liest die freigegebenen Terminarten und verändert keine Daten.

curl --request GET \
  --url https://sandbox.arztkonsultation.io/api/v1/s2s/scheduling/appointment-types \
  --header 'Accept: application/json' \
  --header 'X-API-Key: {PARTNER_API_KEY}'

Eine erfolgreiche Antwort ist tenantgebunden. Behandeln Sie 401 als ungültige oder abgelaufene Authentifizierung, 403 als fehlende Berechtigung und 429 als Signal, die Anfrage mit begrenztem exponentiellem Backoff erneut zu senden.

Sicherer Anfragepfad

flowchart LR
  accTitle: Authentifizierter Partner-Anfragepfad
  Partner[Partner-Backend] --> Edge[Edge und Rate Limit]
  Edge --> Guard[API-Key-Prüfung]
  Guard --> Tenant[Tenantgebundene S2S-Operation]
  Tenant --> Correlation[Antwort mit stabilen Korrelationsdaten]
  Correlation --> Partner

Integration aufbauen

1. Lesen Sie zunächst Terminarten und Slots.
2. Verwenden Sie beim Erstellen einer Buchung eine eigene stabile Fallreferenz, sofern das Request-Schema sie vorsieht.
3. Speichern Sie die zurückgegebenen Identifikatoren für spätere Statusabfragen und Stornierungen.
4. Implementieren Sie Timeouts, begrenzte Retries und strukturierte Logs ohne Schlüssel oder Gesundheitsdaten.

Einstellungen sicher kopieren

Rufen Sie zuerst POST /api/v1/s2s/partners/settings-copy/preview mit synthetischen partnerOrgId-Werten auf. Verwenden Sie standardmäßig FAIL_ON_CONFLICT; dieser Modus schreibt bei Konflikten nichts. Wenn Konflikte bewusst ersetzt werden sollen, erstellen Sie eine neue Preview mit OVERWRITE_CONFLICTS.

Senden Sie anschließend dieselbe Auswahl, Strategie und die erhaltene previewRevision an POST /api/v1/s2s/partners/settings-copy/apply. Apply verlangt einen PHI-freien reason sowie einen stabilen Idempotency-Key. Antwortet Apply wegen Drift mit 409, erstellen Sie eine neue Preview. Nach einem Transportfehler wiederholen Sie exakt denselben Apply-Request mit demselben Header. Antworten und Fehler enthalten keine kopierten Fachwerte.