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

# Beágyazási munkamenet létrehozása

> Kérj egy egyszer használatos URL-t, amely megjeleníti egy profil laboreredményeit az alkalmazásodban

Kérj le egy URL-t, amely egy profil laboreredményeit csak olvasható oldalként jeleníti meg. Nyisd meg az URL-t az alkalmazásod WebView nézetében vagy egy böngészőlapon. Minden alkalommal hívd meg ezt a végpontot a szerveredről, amikor a felhasználó megnyitja az eredményeket, és soha ne gyorsítótárazd az URL-t.

A profil egyik profilcsoportján szükséges az `embed` és a `results_view` scope. Az `embed` scope-ot az Aniva kérésre adja meg. Ha a két scope közül valamelyik hiányzik, a kérés `403` kóddal tér vissza.

> [!NOTE]
>
> Az URL egyszer és 5 percig működik. Amikor megnyílik, az oldal egy 60 perces munkamenetet indít,
> amely csak ahhoz az oldalhoz tartozik. Archiváld az API-kulcsodat, hogy egyszerre bezárd az összes nyitott oldalt.

## Kérés

### Útvonalparaméterek

**id** `string` *required*

Annak a profilnak az egyedi azonosítója (UUID), amelynek az eredményeit az oldal megjeleníti.

### Törzs

A törzs opcionális. Törzs nélkül az URL a profil nyelvén nyitja meg a biomarkerlistát.

**language** `string`

Az oldal nyelve: `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` vagy `uk`. Alapértelmezett: a profil nyelve.

**route** `object`

Az oldal, amelyet az URL megnyit. Alapértelmezett: `{ "name": "biomarkers" }`. Minden más `name` érték `400`-at ad vissza.

**kiadott oldalak**

**name** `string` *required*

Az alábbiak egyike:

* `biomarkers`: az összes biomarker listája a legfrissebb eredményeikkel.
* `biomarker`: egy biomarker részletes oldala a trendjével, a tartományaival és a magyarázatával. Szükséges hozzá a `biomarker_id`.
* `twin`: a 3D-s test egészségügyi területenkénti értékeléssel. A felhasználó kiválaszt egy területet, hogy megnézze annak biomarkereit.

**biomarker\_id** `integer`

Csak a `biomarker` esetén. A biomarker `biomarker_id` azonosítója az eredményekben szereplő módon, például `104`. Az azonosítót használd, ne a slugot: a slug változhat, az azonosító állandó.

**report** `object`

Minden oldalt a profil egyetlen laborleletére korlátoz. Alapértelmezett: a profil összes lelete.
A három azonosító közül pontosan egyet küldj el. A lista, a biomarker trendje és a Twin ekkor
csak annak a leletnek az eredményeit mutatja, és az oldal elrejti az időpontszűrőt. A felhasználó
ezzel az URL-lel nem tud másik leletet megnyitni.

**tulajdonságok**

**appointment\_id** `string`

A profil egyik időpontjának `id` azonosítója. A kulcsodnak hozzá kell férnie, ugyanúgy, mint a
[Laboreredmények lekérése](https://docs.anivahealth.com/hu/api/appointments/get-results.md) végpontnál. Ha nem fér hozzá, ez a
végpont `404`-et ad vissza, nem `403`-at.

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

A profil egyik otthoni tesztkészlet-rendelésének `id` azonosítója. A kulcsodnak hozzá kell
férnie, ugyanúgy, mint az otthoni tesztkészlet-rendelésekhez tartozó
[Laboreredmények lekérése](https://docs.anivahealth.com/hu/api/home-kit-orders/get-results.md) végpontnál, és a
`home_kit_orders_view` vagy a `home_kit_orders_manage` is szükséges hozzá.

**document\_id** `string`

Egy olyan laborlelet `id` azonosítója, amelyet a
[Dokumentum feltöltése](https://docs.anivahealth.com/hu/api/documents/upload-document.md) végponttal töltöttél fel a profilhoz.
A kulcsodnak hozzá kell férnie, ugyanúgy, mint a
[Dokumentumeredmények lekérése](https://docs.anivahealth.com/hu/api/documents/get-document-results.md) végpontnál. Ha nem fér
hozzá, ez a végpont `404`-et ad vissza, nem `403`-at. Az oldal a laborvizsgálat dátumát
mutatja, vagy a feltöltés dátumát, ha még nincs beolvasott érték. Amíg az Aniva beolvassa a
dokumentumot és még nincs érték, minden oldal azt kéri a felhasználótól, hogy nyissa meg újra
néhány perc múlva.

**appearance** `object`

Az oldal megjelenése. Az API lekérdezési paraméterként adja hozzá az URL-hez.

**tulajdonságok**

**theme** `string`

`light` vagy `dark`. Alapértelmezett: az eszköz rendszerbeállítása.

**primary\_color** `string`

A gombok és linkek hexadecimális színe, 3 vagy 6 jegyű, `#` jellel vagy anélkül, például `0f766e`.
Alapértelmezett: a profilcsoportod márkaszíne, ennek hiányában az Aniva narancs. A gombok szövege
fehér marad, ezért válassz sötét színt.

**show\_logo** `boolean`

A profilcsoportod logójának megjelenítése az eredmények felett. Alapértelmezett: `true`.

> [!TIP]
>
> A megjelenési paramétereket saját magad is hozzáfűzheted a visszaadott URL-hez a `#token=`
> rész elé: `theme=light|dark`, `primary=<hex>` és `logo=0`. Az oldal figyelmen kívül hagyja az
> érvénytelen értéket. A logó képe mindig a profilcsoportodból származik, soha nem az URL-ből.

## Válasz

Siker esetén az API `201 Created` választ ad vissza.

**url** `string` *required*

Az oldal URL-je. Az indítási token a `#token=` részben van, így a böngésző soha nem küldi el
szervernek. Egyszer nyisd meg.

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

ISO 8601 formátumú időpont, amely után az URL már nem nyitható meg.

A munkamenet nem egyetlen oldalhoz kötődik. A beágyazott nézeten belül a felhasználó átléphet a Twinből egy biomarkerre, valamint a lista és a részletes oldalak között is válthat. Az oldal csak laboreredményeket jelenít meg: az Aniva által számított értékeket, a fájlokat, a chatet és a beállításokat nem.

## Hibaválaszok

| Státusz | Leírás |
| - | - |
| `400` | Érvényesítési hiba – érvénytelen profilazonosító, ismeretlen `route.name`, érvénytelen `biomarker_id`, érvénytelen szín, vagy olyan `report`, amely nem pontosan egy érvényes UUID-t tartalmaz. |
| `403` | Tiltott – az API-kulcsodból hiányzik az `embed` vagy a `results_view` scope, az otthoni tesztkészlet-rendelés leletéhez szükséges otthoni tesztkészlet scope, vagy a profil a hozzáférési körödön kívül esik. |
| `404` | A profil nem található, nincs ilyen `biomarker_id` azonosítójú biomarker, a `report` nem ehhez a profilhoz tartozó időpont, otthoni tesztkészlet-rendelés vagy feltöltött dokumentum, vagy a lelethez nincs hozzáférésed. Ez a végpont `404`-et ad vissza, nem `403`-at, hogy ne fedje fel a lelet létezését. |
| `500` | Belső szerverhiba. |

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