API Documentation

samedi offers several APIs for integrators. They target different integration scenarios. This page helps you pick the right one and links you to its reference documentation. For technical details, follow the link for each API.

What is a MyPatientPortal?

A MyPatientPortal (MPP) is a samedi-hosted patient portal, in one of two forms:

General portal — the shared samedi portal at https://patient.samedi.de
Tenant-specific portal — a customer-branded portal hosted by samedi under the customer's own domain, e.g. https://patientenportal.vivantes.de/

Which API should I use?

Depending on who owns the patient account and the patient-facing UI, you need to use a different API:

Your scenario	Use this API

Your scenario	Use this API
You build a booking frontend for patients who already have (or will have) a samedi MyPatientPortal account. samedi handles user management, login, and the portal.	MyPatientPortal API
You have an existing integration against the Booking API	Booking API (for new integrations, we recommend using MyPatientPortal API)
You build a complete patient portal of your own and your handle the entire user management, login, administration, medical records, messaging, files, etc. with no samedi MyPatientPortal involved.	samedi Connect API

The APIs

MyPatientPortal API

Most integrators want to use this API. If you are building a booking frontend for patients, start here.

For building a booking frontend on top of a samedi MyPatientPortal. samedi manages patient accounts, login, and the portal; the patient authorizes your application via OAuth. Booking-focused.

Documentation: MyPatientPortal API

Booking API (legacy)

Note: We recommend new integrations to use MyPatientPortal API instead.

The older surface over the same data as the MyPatientPortal API — all patient and appointment data lives in the MyPatientPortal. Covers the same booking use case. samedi also offers a ready-made, customizable Booking Widget as an alternative to a custom integration.

Documentation: Booking API

samedi Connect API

Most integrators do not need this. Use it only if you are replacing the MyPatientPortal entirely with your own portal. Otherwise the MyPatientPortal API is the right choice.

For building a complete patient portal of your own, with no samedi MyPatientPortal involved. Covers the full surface — user management, medical records, messaging, files, forms, encryption, and more — on the samedi platform.

Documentation: samedi Connect API