> ## 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.

# Opret indlejringssession

> Få en engangs-URL, der viser en profils laboratorieresultater i din app

Hent en URL, der viser laboratorieresultaterne for én profil som en skrivebeskyttet side. Åbn URL'en i en WebView i din app eller i en browserfane. Kald dette endpoint fra din server, hver gang brugeren åbner resultaterne, og gem aldrig URL'en i cachen.

Kræver `embed`- og `results_view`-scopes på en profilgruppe for profilen. Aniva giver `embed`-scopet efter anmodning. Uden et af de to scopes returnerer anmodningen `403`.

> [!NOTE]
>
> URL'en virker én gang og i 5 minutter. Når den åbnes, starter siden en 60-minutters session, som
> kun den side har. Arkiver din API-nøgle for at lukke alle åbne sider på én gang.

## Forespørgsel

### Stiparametre

**id** `string` *required*

Unikt id (UUID) for den profil, hvis resultater siden viser.

### Body

Body er valgfri. Uden en body åbner URL'en biomarkørlisten på profilens sprog.

**language** `string`

Sidens sprog: `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` eller `uk`. Standard: profilens sprog.

**route** `object`

Den side, som URL'en åbner. Standard: `{ "name": "biomarkers" }`. Ethvert andet `name` returnerer `400`.

**udgivne sider**

**name** `string` *required*

En af:

* `biomarkers`: listen over alle biomarkører med deres seneste resultater.
* `biomarker`: detaljesiden for én biomarkør med dens udvikling, intervaller og forklaring. Kræver `biomarker_id`.
* `twin`: 3D-kroppen med en karakter pr. sundhedsområde. Brugeren vælger et område for at se dets biomarkører.

**biomarker\_id** `integer`

Kun til `biomarker`. Biomarkørens `biomarker_id`, som i resultaterne, for eksempel `104`. Brug id'et, ikke slug'en: en slug kan ændre sig, id'et ændrer sig ikke.

**report** `object`

Begrænser hver side til én laboratorierapport for profilen. Standard: alle rapporter for profilen. Send
præcis ét af de tre id'er. Listen, udviklingen for en biomarkør og Twin viser derefter kun
resultaterne fra den rapport, og siden skjuler filteret for tider. Brugeren kan ikke åbne
en anden rapport med denne URL.

**egenskaber**

**appointment\_id** `string`

`id` for en tid tilknyttet profilen. Din nøgle skal have adgang til den, ligesom ved
[Hent laboratorieresultater](https://docs.anivahealth.com/da/api/appointments/get-results.md). Har den ikke det, returnerer dette endpoint
`404`, ikke `403`.

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

`id` for en hjemmetestkitordre tilknyttet profilen. Din nøgle skal have adgang til den, ligesom ved
[Hent laboratorieresultater](https://docs.anivahealth.com/da/api/home-kit-orders/get-results.md) for hjemmetestkitordrer, og kræver også
`home_kit_orders_view` eller `home_kit_orders_manage`.

**document\_id** `string`

`id` for en laboratorierapport, som du har uploadet for profilen med
[Upload dokument](https://docs.anivahealth.com/da/api/documents/upload-document.md). Din nøgle skal have adgang til den, ligesom ved
[Hent dokumentresultater](https://docs.anivahealth.com/da/api/documents/get-document-results.md). Har den ikke det, returnerer dette endpoint
`404`, ikke `403`. Siden viser datoen for laboratorietesten eller uploaddatoen, når
der endnu ikke er aflæst nogen værdi. Mens Aniva aflæser dokumentet og endnu ikke har nogen værdi, beder hver side
brugeren om at åbne den igen om et par minutter.

**appearance** `object`

Sidens udseende. API'et tilføjer det til URL'en som søgeparametre.

**egenskaber**

**theme** `string`

`light` eller `dark`. Standard: enhedens systemindstilling.

**primary\_color** `string`

Hex-farve til knapper og links, 3 eller 6 tegn, med eller uden `#`, for eksempel `0f766e`.
Standard: din profilgruppes brandfarve, ellers Aniva-orange. Knapper beholder hvid tekst,
så vælg en mørk farve.

**show\_logo** `boolean`

Vis din profilgruppes logo over resultaterne. Standard: `true`.

> [!TIP]
>
> Du kan også selv tilføje udseendeparametrene til en returneret URL før
> `#token=`-fragmentet: `theme=light|dark`, `primary=<hex>` og `logo=0`. Siden ignorerer en ugyldig værdi.
> Logobilledet kommer altid fra din profilgruppe, aldrig fra URL'en.

## Svar

Ved succes returnerer API'et `201 Created`.

**url** `string` *required*

Sidens URL. Starttokenet ligger i `#token=`-fragmentet, så en browser aldrig sender det til en
server. Åbn den én gang.

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

ISO 8601-tidspunkt, hvorefter URL'en ikke kan åbnes.

Sessionen er ikke bundet til én side. Inde i embed-visningen kan brugeren gå fra Twin til en biomarkør og mellem listen og detaljesiderne. Siden viser kun laboratorieresultater: den viser ikke værdier beregnet af Aniva, filer, chat eller indstillinger.

## Fejlsvar

| Status | Beskrivelse |
| - | - |
| `400` | Valideringsfejl – ugyldigt profil-id, ukendt `route.name`, ugyldigt `biomarker_id`, ugyldig farve eller en `report` uden præcis ét gyldigt UUID. |
| `403` | Adgang nægtet – din API-nøgle mangler scopet `embed` eller `results_view`, eller hjemmetestkit-scopet for en rapport på en hjemmetestkitordre, eller profilen ligger uden for din adgangskontekst. |
| `404` | Profilen blev ikke fundet, ingen biomarkør har dette `biomarker_id`, `report` er ikke en tid, hjemmetestkitordre eller et uploadet dokument for denne profil, eller rapporten ligger uden for din adgang. Dette endpoint returnerer `404`, ikke `403`, så det ikke viser, at rapporten findes. |
| `500` | Intern serverfejl. |

```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.