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

# Skapa inbäddningssession

> Hämta en engångs-URL som visar en profils labbresultat i din app

Hämta en URL som visar labbresultaten för en profil som en skrivskyddad sida. Öppna URL:en i en WebView i din app eller i en webbläsarflik. Anropa den här endpointen från din server varje gång användaren öppnar resultaten och cacha aldrig URL:en.

Kräver behörigheterna `embed` och `results_view` på en profilgrupp för profilen. Aniva beviljar behörigheten `embed` på begäran. Utan någon av de två behörigheterna returnerar anropet `403`.

> [!NOTE]
>
> URL:en fungerar en gång och i 5 minuter. När den öppnas startar sidan en 60-minuterssession som
> bara den sidan har. Arkivera din API-nyckel för att stänga alla öppna sidor samtidigt.

## Förfrågan

### Sökvägsparametrar

**id** `string` *required*

Unik identifierare (UUID) för profilen vars resultat sidan visar.

### Body

Bodyn är valfri. Utan body öppnar URL:en biomarkörslistan på profilens språk.

**language** `string`

Sidans språ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: profilens språk.

**route** `object`

Sidan som URL:en öppnar. Standard: `{ "name": "biomarkers" }`. Alla andra `name` returnerar `400`.

**släppta sidor**

**name** `string` *required*

Ett av:

* `biomarkers`: listan över alla biomarkörer med deras senaste resultat.
* `biomarker`: detaljsidan för en biomarkör, med dess trend, intervall och förklaring. Kräver `biomarker_id`.
* `twin`: 3D-kroppen med ett betyg per hälsoområde. Användaren väljer ett område för att se dess biomarkörer.

**biomarker\_id** `integer`

Bara för `biomarker`. Biomarkörens `biomarker_id`, som i resultaten, till exempel `104`. Använd id:t, inte sluggen: en slug kan ändras, id:t består.

**report** `object`

Begränsar varje sida till en labbrapport för profilen. Standard: alla rapporter för profilen. Skicka
exakt ett av de tre id:na. Listan, trenden för en biomarkör och Twin visar då bara
resultaten från den rapporten, och sidan döljer bokningsfiltret. Användaren kan inte öppna
en annan rapport med den här URL:en.

**egenskaper**

**appointment\_id** `string`

`id` för en av profilens bokningar. Din nyckel måste ha åtkomst till den, precis som för
[Hämta labbresultat](https://docs.anivahealth.com/sv/api/appointments/get-results.md). Annars returnerar den här slutpunkten
`404`, inte `403`.

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

`id` för en beställning av hemtestkit för profilen. Din nyckel måste ha åtkomst till den, precis som för
[Hämta labbresultat](https://docs.anivahealth.com/sv/api/home-kit-orders/get-results.md) för beställningar av hemtestkit, och behöver också
`home_kit_orders_view` eller `home_kit_orders_manage`.

**document\_id** `string`

`id` för en labbrapport som du laddat upp för profilen med
[Ladda upp dokument](https://docs.anivahealth.com/sv/api/documents/upload-document.md). Din nyckel måste ha åtkomst till den, precis som för
[Hämta dokumentresultat](https://docs.anivahealth.com/sv/api/documents/get-document-results.md). Annars returnerar den här slutpunkten
`404`, inte `403`. Sidan visar datumet för labbtestet, eller uppladdningsdatumet när
inget värde har lästs in än. Medan Aniva läser dokumentet och inte har något värde än ber varje sida
användaren att öppna den igen om några minuter.

**appearance** `object`

Sidans utseende. API:et lägger till det i URL:en som sökparametrar.

**egenskaper**

**theme** `string`

`light` eller `dark`. Standard: enhetens systeminställning.

**primary\_color** `string`

Hexfärg för knappar och länkar, 3 eller 6 tecken, med eller utan `#`, till exempel `0f766e`.
Standard: din profilgrupps varumärkesfärg, annars Aniva-orange. Knappar behåller vit text,
så välj en mörk färg.

**show\_logo** `boolean`

Visa din profilgrupps logotyp ovanför resultaten. Standard: `true`.

> [!TIP]
>
> Du kan också själv lägga till utseendeparametrarna i en returnerad URL, före fragmentet
> `#token=`: `theme=light|dark`, `primary=<hex>` och `logo=0`. Sidan ignorerar ett ogiltigt värde.
> Logotypbilden kommer alltid från din profilgrupp, aldrig från URL:en.

## Svar

Vid lyckat anrop returnerar API:et `201 Created`.

**url** `string` *required*

Sidans URL. Starttoken ligger i fragmentet `#token=`, så en webbläsare skickar den aldrig till en
server. Öppna den en gång.

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

ISO 8601-tidpunkt efter vilken URL:en inte kan öppnas.

Sessionen är inte bunden till en enda sida. I inbäddningen kan användaren gå från Twin till en biomarkör och mellan listan och detaljsidorna. Sidan visar bara labbresultat: den visar inte värden som Aniva beräknar, filer, chatt eller inställningar.

## Felsvar

| Status | Beskrivning |
| - | - |
| `400` | Valideringsfel — ogiltigt profil-ID, okänt `route.name`, ogiltigt `biomarker_id`, ogiltig färg eller en `report` utan exakt ett giltigt UUID. |
| `403` | Åtkomst nekad — din API-nyckel saknar scopet `embed` eller `results_view`, eller hemtestkit-scopet för en rapport från en beställning av hemtestkit, eller så ligger profilen utanför din åtkomstkontext. |
| `404` | Profilen hittades inte, ingen biomarkör har detta `biomarker_id`, `report` är inte en bokning, beställning av hemtestkit eller ett uppladdat dokument för den här profilen, eller så ligger rapporten utanför din åtkomst. Den här slutpunkten returnerar `404`, inte `403`, för att inte visa att rapporten finns. |
| `500` | Internt serverfel. |

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