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

# Luo upotusistunto

> Hae kertakäyttöinen URL-osoite, joka näyttää profiilin laboratoriotulokset sovelluksessasi

Hae URL-osoite, joka näyttää yhden profiilin laboratoriotulokset vain luku -sivuna. Avaa URL-osoite sovelluksesi WebView-näkymässä tai selaimen välilehdessä. Kutsu tätä päätepistettä palvelimeltasi joka kerta, kun käyttäjä avaa tulokset, äläkä koskaan tallenna URL-osoitetta välimuistiin.

Vaatii `embed`- ja `results_view`-käyttöoikeudet jollekin profiilin profiiliryhmistä. Aniva myöntää `embed`-käyttöoikeuden pyynnöstä. Jos jompikumpi käyttöoikeus puuttuu, pyyntö palauttaa koodin `403`.

> [!NOTE]
>
> URL-osoite toimii kerran ja 5 minuutin ajan. Kun se avataan, sivu käynnistää 60 minuutin
> istunnon, joka on voimassa vain kyseisellä sivulla. Arkistoi API-avaimesi sulkeaksesi kaikki
> avoimet sivut kerralla.

## Pyyntö

### Polkuparametrit

**id** `string` *required*

Sen profiilin yksilöllinen tunniste (UUID), jonka tulokset sivu näyttää.

### Runko

Runko on valinnainen. Ilman runkoa URL-osoite avaa biomarkkeriluettelon profiilin kielellä.

**language** `string`

Sivun kieli: `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` tai `uk`. Oletus: profiilin kieli.

**route** `object`

Sivu, jonka URL-osoite avaa. Oletus: `{ "name": "biomarkers" }`. Mikä tahansa muu `name` palauttaa `400`.

**julkaistut sivut**

**name** `string` *required*

Jokin seuraavista:

* `biomarkers`: luettelo kaikista biomarkkereista ja niiden uusimmista tuloksista.
* `biomarker`: yhden biomarkkerin tietosivu, jossa näkyvät sen trendi, viitealueet ja selitys. Vaatii kentän `biomarker_id`.
* `twin`: 3D-keho, jossa on arvosana kullekin terveysalueelle. Käyttäjä valitsee alueen nähdäkseen sen biomarkkerit.

**biomarker\_id** `integer`

Vain arvolle `biomarker`. Biomarkkerin `biomarker_id`, kuten tuloksissa, esimerkiksi `104`. Käytä id:tä, älä slugia: slug voi muuttua, id pysyy samana.

**report** `object`

Rajaa jokaisen sivun yhteen profiilin laboratorioraporttiin. Oletus: kaikki profiilin raportit.
Lähetä tarkalleen yksi kolmesta tunnisteesta. Luettelo, biomarkkerin trendi ja Twin näyttävät
silloin vain kyseisen raportin tulokset, ja sivu piilottaa ajanvaraussuodattimen. Käyttäjä ei voi
avata toista raporttia tällä URL-osoitteella.

**ominaisuudet**

**appointment\_id** `string`

Profiilin ajanvarauksen `id`. Avaimellasi täytyy olla pääsy siihen, kuten päätepisteessä
[Hae laboratoriotulokset](https://docs.anivahealth.com/fi/api/appointments/get-results.md). Jos ei ole, tämä päätepiste
palauttaa `404`, ei `403`.

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

Profiilin kotitestipakkaustilauksen `id`. Avaimellasi täytyy olla pääsy siihen, kuten
kotitestipakkaustilausten päätepisteessä
[Hae laboratoriotulokset](https://docs.anivahealth.com/fi/api/home-kit-orders/get-results.md), ja lisäksi se tarvitsee
oikeuden `home_kit_orders_view` tai `home_kit_orders_manage`.

**document\_id** `string`

Laboratorioraportin `id`, jonka lähetit profiilille päätepisteellä
[Lähetä asiakirja](https://docs.anivahealth.com/fi/api/documents/upload-document.md). Avaimellasi täytyy olla pääsy siihen,
kuten päätepisteessä [Hae asiakirjan tulokset](https://docs.anivahealth.com/fi/api/documents/get-document-results.md). Jos ei
ole, tämä päätepiste palauttaa `404`, ei `403`. Sivu näyttää laboratoriotestin päivämäärän
tai lähetyspäivän, kun yhtään arvoa ei ole vielä luettu. Kun Aniva lukee asiakirjaa eikä
arvoja vielä ole, jokainen sivu kehottaa käyttäjää avaamaan sen uudelleen muutaman minuutin
kuluttua.

**appearance** `object`

Sivun ulkoasu. API lisää sen URL-osoitteeseen kyselyparametreina.

**ominaisuudet**

**theme** `string`

`light` tai `dark`. Oletus: laitteen järjestelmäasetus.

**primary\_color** `string`

Painikkeiden ja linkkien heksaväri, 3 tai 6 merkkiä, `#`-merkillä tai ilman, esimerkiksi
`0f766e`. Oletus: profiiliryhmäsi brändiväri, muuten Aniva-oranssi. Painikkeissa säilyy
valkoinen teksti, joten valitse tumma väri.

**show\_logo** `boolean`

Näytä profiiliryhmäsi logo tulosten yläpuolella. Oletus: `true`.

> [!TIP]
>
> Voit myös lisätä ulkoasuparametrit palautettuun URL-osoitteeseen itse ennen `#token=`-fragmenttia:
> `theme=light|dark`, `primary=<hex>` ja `logo=0`. Sivu ohittaa virheellisen arvon.
> Logokuva tulee aina profiiliryhmästäsi, ei koskaan URL-osoitteesta.

## Vastaus

Onnistuessaan API palauttaa `201 Created`.

**url** `string` *required*

Sivun URL-osoite. Käynnistystunniste on `#token=`-fragmentissa, joten selain ei koskaan lähetä
sitä palvelimelle. Avaa se kerran.

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

ISO 8601 -ajankohta, jonka jälkeen URL-osoitetta ei voi enää avata.

Istunto ei ole sidottu yhteen sivuun. Upotuksen sisällä käyttäjä voi siirtyä Twinistä biomarkkeriin sekä luettelon ja tietosivujen välillä. Sivu näyttää vain laboratoriotulokset: se ei näytä Anivan laskemia arvoja, tiedostoja, chattia tai asetuksia.

## Virhevastaukset

| Tila | Kuvaus |
| - | - |
| `400` | Validointivirhe — virheellinen profiilin ID, tuntematon `route.name`, virheellinen `biomarker_id`, virheellinen väri tai `report`, jossa ei ole tarkalleen yhtä kelvollista UUID:tä. |
| `403` | Estetty — API-avaimeltasi puuttuu `embed`- tai `results_view`-oikeus, kotitestipakkaustilauksen raportin edellyttämä kotitestipakkausoikeus, tai profiili on käyttöoikeusalueesi ulkopuolella. |
| `404` | Profiilia ei löytynyt, yhdelläkään biomarkkerilla ei ole tätä `biomarker_id`-arvoa, `report` ei ole tämän profiilin ajanvaraus, kotitestipakkaustilaus tai lähetetty asiakirja, tai raportti on pääsysi ulkopuolella. Tämä päätepiste palauttaa `404`, ei `403`, jotta se ei paljasta raportin olemassaoloa. |
| `500` | Sisäinen palvelinvirhe. |

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