Partner API quickstart

Partner API 1.0.0 uses JSON over HTTPS. Start in the sandbox with synthetic test data only. Keep API keys in a server-side secret store; never expose them in browsers, mobile apps, URLs or logs.

Make the first request

Send the key in X-API-Key. This read request lists published appointment types and does not change data.

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

Treat 401 as invalid or expired authentication, 403 as an insufficient scope, and 429 as a signal to retry with bounded exponential backoff.

Build the integration

  1. Read appointment types and slots before creating data.
  2. Send your stable case reference where the published request schema supports it.
  3. Store returned identifiers for status checks and cancellations.
  4. Use timeouts, bounded retries and structured logs without keys or health data.

Contract 1.0.0

The machine-readable OpenAPI file is the contract. Validate request and response models against the published version before production.