> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Embed-Sitzung erstellen

> Eine einmalige URL abrufen, die die Laborergebnisse eines Profils in deiner App anzeigt

Fordere eine URL an, die die Laborergebnisse eines Profils als schreibgeschützte Seite anzeigt. Öffne die URL in einer WebView deiner App oder in einem Browser-Tab. Rufe diesen Endpunkt jedes Mal von deinem Server auf, wenn der Nutzer die Ergebnisse öffnet, und speichere die URL niemals im Cache.

Erfordert die Scopes `embed` und `results_view` auf einer Profilgruppe des Profils. Aniva vergibt den Scope `embed` auf Anfrage. Fehlt einer der beiden Scopes, gibt die Anfrage `403` zurück.

> [!NOTE]
>
> Die URL funktioniert einmalig und 5 Minuten lang. Beim Öffnen startet die Seite eine 60-minütige
> Sitzung, die nur diese Seite hält. Archiviere deinen API-Schlüssel, um alle offenen Seiten sofort
> zu schließen.

## Anfrage

### Pfadparameter

**id** `string` *required*

Eindeutige Kennung (UUID) des Profils, dessen Ergebnisse die Seite zeigt.

### Body

Der Body ist optional. Ohne Body öffnet die URL die Biomarker-Liste in der Sprache des Profils.

**language** `string`

Sprache der Seite: `en`, `bg`, `ca`, `cs`, `da`, `de`, `el`, `es`, `et`, `fi`, `fr`, `ga`, `hr`, `hu`, `is`, `it`, `lb`, `lt`, `lv`, `mt`, `nl`, `no`, `pl`, `pt`, `ro`, `ru`, `sk`, `sl`, `sr`, `sv`, `tr` oder `uk`. Standard: die Sprache des Profils.

**route** `object`

Die Seite, die die URL öffnet. Standard: `{ "name": "biomarkers" }`. Jeder andere `name` gibt `400` zurück.

**freigegebene Seiten**

**name** `string` *required*

Einer der folgenden Werte:

* `biomarkers`: die Liste aller Biomarker mit ihren neuesten Ergebnissen.
* `biomarker`: die Detailseite eines Biomarkers mit Verlauf, Bereichen und Erklärung. Erfordert `biomarker_id`.
* `twin`: der 3D-Körper mit einer Bewertung pro Gesundheitsbereich. Nutzer wählen einen Bereich aus, um dessen Biomarker zu sehen.

**biomarker\_id** `integer`

Nur für `biomarker`. Die `biomarker_id` des Biomarkers wie in den Ergebnissen, zum Beispiel `104`. Verwende die ID, nicht den Slug: Ein Slug kann sich ändern, die ID bleibt.

**report** `object`

Beschränkt jede Seite auf einen Laborbericht des Profils. Standard: alle Berichte des Profils.
Sende genau eine der drei IDs. Die Liste, der Verlauf eines Biomarkers und der Twin zeigen dann
nur die Ergebnisse dieses Berichts, und die Seite blendet den Terminfilter aus. Nutzer können mit
dieser URL keinen anderen Bericht öffnen.

**Eigenschaften**

**appointment\_id** `string`

Die `id` eines Termins des Profils. Dein Schlüssel muss darauf Zugriff haben, wie bei
[Laborergebnisse abrufen](https://docs.anivahealth.com/de/api/appointments/get-results.md). Wenn nicht, gibt dieser Endpunkt
`404` statt `403` zurück.

**home\_kit\_order\_id** `string`

Die `id` einer Heimtest-Kit-Bestellung des Profils. Dein Schlüssel muss darauf Zugriff haben,
wie bei [Laborergebnisse abrufen](https://docs.anivahealth.com/de/api/home-kit-orders/get-results.md) für
Heimtest-Kit-Bestellungen, und zusätzlich `home_kit_orders_view` oder
`home_kit_orders_manage` besitzen.

**document\_id** `string`

Die `id` eines Laborberichts, den du für das Profil mit
[Dokument hochladen](https://docs.anivahealth.com/de/api/documents/upload-document.md) hochgeladen hast. Dein Schlüssel muss
darauf Zugriff haben, wie bei [Dokumentergebnisse abrufen](https://docs.anivahealth.com/de/api/documents/get-document-results.md).
Wenn nicht, gibt dieser Endpunkt `404` statt `403` zurück. Die Seite zeigt das Datum des
Labortests oder das Upload-Datum, wenn noch kein Wert ausgelesen wurde. Während Aniva das
Dokument ausliest und noch kein Wert vorliegt, weist jede Seite Nutzer darauf hin, sie in ein
paar Minuten erneut zu öffnen.

**appearance** `object`

Das Erscheinungsbild der Seite. Die API hängt es als Suchparameter an die URL an.

**Eigenschaften**

**theme** `string`

`light` oder `dark`. Standard: die Systemeinstellung des Geräts.

**primary\_color** `string`

Hex-Farbe für Buttons und Links, 3 oder 6 Stellen, mit oder ohne `#`, zum Beispiel `0f766e`.
Standard: die Markenfarbe deiner Profilgruppe, sonst Aniva-Orange. Buttons behalten weißen
Text, wähle also eine dunkle Farbe.

**show\_logo** `boolean`

Zeigt das Logo deiner Profilgruppe über den Ergebnissen an. Standard: `true`.

> [!TIP]
>
> Du kannst die Parameter für das Erscheinungsbild auch selbst an eine zurückgegebene URL
> anhängen, vor dem Fragment `#token=`: `theme=light|dark`, `primary=<hex>` und `logo=0`. Die Seite
> ignoriert ungültige Werte. Das Logo stammt immer aus deiner Profilgruppe, niemals aus der URL.

## Antwort

Bei Erfolg gibt die API `201 Created` zurück.

**url** `string` *required*

Die Seiten-URL. Das Launch-Token steht im Fragment `#token=`, sodass ein Browser es niemals an
einen Server sendet. Öffne sie einmal.

**expires\_at** `string` *required*

Zeitpunkt nach ISO 8601, ab dem die URL nicht mehr geöffnet werden kann.

Die Sitzung ist nicht an eine einzelne Seite gebunden. Innerhalb des Embeds können Nutzer vom Twin zu einem Biomarker sowie zwischen der Liste und den Detailseiten wechseln. Die Seite zeigt nur Laborergebnisse: Sie zeigt keine von Aniva berechneten Werte, keine Dateien, keinen Chat und keine Einstellungen.

## Fehlerantworten

| Status | Beschreibung |
| - | - |
| `400` | Validierungsfehler – ungültige Profil-ID, unbekannter `route.name`, ungültige `biomarker_id`, ungültige Farbe oder ein `report` ohne genau eine gültige UUID. |
| `403` | Zugriff verweigert – deinem API-Schlüssel fehlt der Scope `embed` oder `results_view` oder der Heimtest-Kit-Scope für den Bericht einer Heimtest-Kit-Bestellung, oder das Profil liegt außerhalb deines Zugriffskontexts. |
| `404` | Profil nicht gefunden, kein Biomarker hat diese `biomarker_id`, `report` ist kein Termin, keine Heimtest-Kit-Bestellung und kein hochgeladenes Dokument dieses Profils, oder der Bericht liegt außerhalb deines Zugriffs. Dieser Endpunkt gibt `404` statt `403` zurück, damit nicht sichtbar wird, dass der Bericht existiert. |
| `500` | Interner Serverfehler. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles/a3f1c2d4-8b7e-4f2a-9c1d-2e3f4a5b6c7d/embed-sessions \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "language": "de",
    "route": { "name": "biomarker", "biomarker_id": 104 },
    "report": { "appointment_id": "8d2e4f6a-1b3c-4d5e-9f70-a1b2c3d4e5f6" },
    "appearance": { "theme": "light", "primary_color": "0f766e" }
  }'
```

```bash One uploaded document theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/profiles/{id}/embed-sessions \
  --header 'Authorization: Bearer <api_key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "report": { "document_id": "3f9a7c2e-5d4b-4e1a-8c6f-0b1d2e3f4a5b" }
  }'
```

```json 201 theme={null}
{
  "url": "https://anivahealth.com/de/embed/biomarkers/vitamin-d?theme=light&primary=0f766e#token=eyJwdXJwb3NlIjoiZW1iZWRfbGF1bmNoIi4uLn0.k7Qm2V0sZ1yH",
  "expires_at": "2026-11-19T20:17:43.000Z"
}
```

```json 400 theme={null}
{
  "error": "route.name: Invalid discriminator value. Expected 'biomarkers' | 'biomarker' | 'twin'"
}
```

```json 403 theme={null}
{
  "error": "Access denied: profile is outside your permission scope"
}
```

```json 404 theme={null}
{
  "error": "Appointment not found"
}
```

```json 404 document theme={null}
{
  "error": "Document not found"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.