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

# Opprett innebyggingsøkt

> Få en engangs-URL som viser labresultatene til en profil inne i appen din

Hent en URL som viser labresultatene for én profil som en skrivebeskyttet side. Åpne URL-en i en WebView i appen din eller i en nettleserfane. Kall dette endepunktet fra serveren din hver gang brukeren åpner resultatene, og mellomlagre aldri URL-en.

Krever scopene `embed` og `results_view` på en profilgruppe for profilen. Aniva gir scopet `embed` på forespørsel. Uten ett av de to scopene returnerer forespørselen `403`.

> [!NOTE]
>
> URL-en fungerer én gang og i 5 minutter. Når den åpnes, starter siden en 60-minutters økt som
> bare den siden har. Arkiver API-nøkkelen din for å lukke alle åpne sider samtidig.

## Forespørsel

### Stiparametere

**id** `string` *required*

Unik identifikator (UUID) for profilen siden viser resultater for.

### Body

Body er valgfri. Uten body åpner URL-en biomarkørlisten på språket til profilen.

**language** `string`

Sidespråk: `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: språket til profilen.

**route** `object`

Siden URL-en åpner. Standard: `{ "name": "biomarkers" }`. Alle andre `name`-verdier returnerer `400`.

**utgitte sider**

**name** `string` *required*

En av:

* `biomarkers`: listen over alle biomarkører med de nyeste resultatene.
* `biomarker`: detaljsiden for én biomarkør, med trend, områder og forklaring. Krever `biomarker_id`.
* `twin`: 3D-kroppen med en karakter per helseområde. Brukeren velger et område for å se biomarkørene for det.

**biomarker\_id** `integer`

Kun for `biomarker`. Biomarkørens `biomarker_id`, slik den vises i resultatene, for eksempel `104`. Bruk ID-en, ikke slug-en: en slug kan endres, ID-en forblir den samme.

**report** `object`

Begrenser hver side til én labrapport for profilen. Standard: alle rapporter for profilen. Send
nøyaktig én av de tre ID-ene. Listen, trenden for en biomarkør og Twin viser da bare
resultatene fra den rapporten, og siden skjuler timefilteret. Brukeren kan ikke åpne
en annen rapport med denne URL-en.

**egenskaper**

**appointment\_id** `string`

`id` for en av profilens timer. Nøkkelen din må ha tilgang til den, slik som for
[Hent labresultater](https://docs.anivahealth.com/no/api/appointments/get-results.md). Hvis den ikke har det, returnerer dette endepunktet
`404`, ikke `403`.

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

`id` for en av profilens bestillinger av hjemmetestsett. Nøkkelen din må ha tilgang til den, slik som for
[Hent labresultater](https://docs.anivahealth.com/no/api/home-kit-orders/get-results.md) for bestillinger av hjemmetestsett, og trenger også
`home_kit_orders_view` eller `home_kit_orders_manage`.

**document\_id** `string`

`id` for en labrapport du lastet opp for profilen med
[Last opp dokument](https://docs.anivahealth.com/no/api/documents/upload-document.md). Nøkkelen din må ha tilgang til den, slik som for
[Hent dokumentresultater](https://docs.anivahealth.com/no/api/documents/get-document-results.md). Hvis den ikke har det, returnerer dette endepunktet
`404`, ikke `403`. Siden viser datoen for labtesten, eller opplastingsdatoen når
ingen verdi er lest ennå. Mens Aniva leser dokumentet og ikke har noen verdi ennå, ber hver side
brukeren om å åpne den på nytt om noen minutter.

**appearance** `object`

Utseendet til siden. API-et legger det til i URL-en som søkeparametere.

**egenskaper**

**theme** `string`

`light` eller `dark`. Standard: systeminnstillingen på enheten.

**primary\_color** `string`

Hex-farge for knapper og lenker, 3 eller 6 sifre, med eller uten `#`, for eksempel `0f766e`.
Standard: merkevarefargen til profilgruppen din, ellers Aniva-oransje. Knapper beholder hvit tekst,
så velg en mørk farge.

**show\_logo** `boolean`

Vis logoen til profilgruppen din over resultatene. Standard: `true`.

> [!TIP]
>
> Du kan også legge til utseendeparameterne selv på en returnert URL før fragmentet
> `#token=`: `theme=light|dark`, `primary=<hex>` og `logo=0`. Siden ignorerer ugyldige verdier.
> Logobildet kommer alltid fra profilgruppen din, aldri fra URL-en.

## Respons

Ved suksess returnerer API-et `201 Created`.

**url** `string` *required*

URL-en til siden. Starttokenet ligger i `#token=`-fragmentet, så nettleseren sender det aldri til en
server. Åpne den én gang.

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

ISO 8601-tidspunkt som URL-en ikke kan åpnes etter.

Økten er ikke bundet til én side. I den innebygde visningen kan brukeren gå fra Twin til en biomarkør og mellom listen og detaljsidene. Siden viser bare labresultater: den viser ikke verdier Aniva beregner, filer, chat eller innstillinger.

## Feilresponser

| Status | Beskrivelse |
| - | - |
| `400` | Valideringsfeil — ugyldig profil-ID, ukjent `route.name`, ugyldig `biomarker_id`, ugyldig farge eller en `report` uten nøyaktig én gyldig UUID. |
| `403` | Ingen tilgang — API-nøkkelen din mangler scope-et `embed` eller `results_view`, eller scope-et for hjemmetestsett ved en rapport for bestilling av hjemmetestsett, eller profilen ligger utenfor tilgangskonteksten din. |
| `404` | Profilen ble ikke funnet, ingen biomarkør har denne `biomarker_id`, `report` er ikke en time, bestilling av hjemmetestsett eller opplastet dokument for denne profilen, eller rapporten ligger utenfor tilgangen din. Dette endepunktet returnerer `404`, ikke `403`, for ikke å vise at rapporten finnes. |
| `500` | Intern serverfeil. |

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