Partner API Referenz

Die arztkonsultation Partner API ist der öffentliche, serverseitige Vertrag für Integrationspartner. Die stabile Erstveröffentlichung ist 1.0.0. Alle Partner-Operationen liegen im kompatiblen Namespace /api/v1/s2s/.

Vertrag und Referenz

Die OpenAPI-Datei ist die verbindliche, maschinenlesbare Referenz. Verwenden Sie sie für Validierung, Client-Generierung und Release-Prüfungen. Die Leitfäden ergänzen den Vertrag, ersetzen ihn jedoch nicht.

Schnellstart für die erste sichere Anfrage
Authentifizierung für Schlüsselbereitstellung und Rotation
Webhooks für signierte Ereigniszustellung
Versionierung für Kompatibilitätsregeln
OpenAPI JSON 1.0.0
OpenAPI YAML 1.0.0
Checksums 1.0.0

Öffentliche Oberfläche

Die Referenz enthält ausschließlich ausdrücklich freigegebene Partner-Operationen. Gesundheitschecks, interne Verwaltungsfunktionen und nicht freigegebene Oberflächen gehören nicht zu diesem Vertrag und erscheinen nicht in dieser Dokumentation.

Die Dateien unter /api/versions/1.0.0/ bleiben als historische Ausgabe verfügbar. Sie enthalten dieselben bytes wie die aktuelle Erstveröffentlichung und können über SHA256SUMS unabhängig geprüft werden.

Server-to-server

Die API ist für Backend-Integrationen vorgesehen. API-Schlüssel und Webhook-Secrets dürfen nicht in Browsern, mobilen Apps oder URLs verwendet werden.

Language

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}'

Freigegebene Endpunkte

Aus dem unveränderlichen OpenAPI-Vertrag 1.0.0.

OpenAPI JSON

Termine & Buchungen

Behandelnde & Verfügbarkeiten

Partner-Apotheken & Organisationen

Webhooks

Räume & Ressourcen