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

# Creează o sesiune de încorporare

> Obține un URL de unică folosință care afișează rezultatele de laborator ale unui profil în aplicația ta

Obține un URL care afișează rezultatele de laborator ale unui profil ca pagină doar pentru citire. Deschide URL-ul într-un WebView al aplicației tale sau într-o filă de browser. Apelează acest endpoint de pe serverul tău de fiecare dată când utilizatorul deschide rezultatele și nu salva niciodată URL-ul în cache.

Necesită scope-urile `embed` și `results_view` pe un grup de profiluri al profilului. Aniva acordă scope-ul `embed` la cerere. Fără unul dintre cele două scope-uri, cererea returnează `403`.

> [!NOTE]
>
> URL-ul funcționează o singură dată și timp de 5 minute. Când se deschide, pagina pornește o sesiune de 60 de minute pe care
> doar acea pagină o deține. Arhivează-ți cheia API pentru a închide simultan toate paginile deschise.

## Cerere

### Parametri de cale

**id** `string` *required*

Identificatorul unic (UUID) al profilului ale cărui rezultate le afișează pagina.

### Corp

Corpul este opțional. Fără corp, URL-ul deschide lista de biomarkeri în limba profilului.

**language** `string`

Limba paginii: `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` sau `uk`. Implicit: limba profilului.

**route** `object`

Pagina pe care o deschide URL-ul. Implicit: `{ "name": "biomarkers" }`. Orice alt `name` returnează `400`.

**pagini lansate**

**name** `string` *required*

Una dintre:

* `biomarkers`: lista tuturor biomarkerilor cu cele mai recente rezultate.
* `biomarker`: pagina de detalii a unui biomarker, cu evoluția, intervalele și explicația acestuia. Necesită `biomarker_id`.
* `twin`: corpul 3D cu o notă pentru fiecare zonă de sănătate. Utilizatorul selectează o zonă pentru a-i vedea biomarkerii.

**biomarker\_id** `integer`

Doar pentru `biomarker`. Valoarea `biomarker_id` a biomarkerului, ca în rezultate, de exemplu `104`. Folosește ID-ul, nu slug-ul: un slug se poate schimba, ID-ul rămâne.

**report** `object`

Limitează fiecare pagină la un singur raport de laborator al profilului. Implicit: toate rapoartele profilului. Trimite
exact unul dintre cele trei ID-uri. Lista, evoluția unui biomarker și Twin afișează atunci doar
rezultatele acelui raport, iar pagina ascunde filtrul de programări. Utilizatorul nu poate deschide
un alt raport cu acest URL.

**proprietăți**

**appointment\_id** `string`

Valoarea `id` a unei programări a profilului. Cheia ta trebuie să aibă acces la aceasta, ca pentru
[Obține rezultatele de laborator](https://docs.anivahealth.com/ro/api/appointments/get-results.md). Dacă nu are, acest endpoint returnează
`404`, nu `403`.

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

Valoarea `id` a unei comenzi de kit de testare la domiciliu a profilului. Cheia ta trebuie să aibă acces la aceasta, ca pentru
[Obține rezultatele de laborator](https://docs.anivahealth.com/ro/api/home-kit-orders/get-results.md) pentru comenzi de kituri de testare la domiciliu, și are nevoie și de
`home_kit_orders_view` sau `home_kit_orders_manage`.

**document\_id** `string`

Valoarea `id` a unui raport de laborator pe care l-ai încărcat pentru profil cu
[Încarcă document](https://docs.anivahealth.com/ro/api/documents/upload-document.md). Cheia ta trebuie să aibă acces la acesta, ca pentru
[Obține rezultatele documentului](https://docs.anivahealth.com/ro/api/documents/get-document-results.md). Dacă nu are, acest endpoint
returnează `404`, nu `403`. Pagina afișează data testului de laborator sau data încărcării atunci când
nu a fost citită încă nicio valoare. Cât timp Aniva citește documentul și nu are încă nicio valoare, fiecare pagină îi spune
utilizatorului să o redeschidă în câteva minute.

**appearance** `object`

Aspectul paginii. API-ul îl adaugă la URL ca parametri de interogare.

**proprietăți**

**theme** `string`

`light` sau `dark`. Implicit: setarea de sistem a dispozitivului.

**primary\_color** `string`

Culoarea hex a butoanelor și linkurilor, din 3 sau 6 cifre, cu sau fără `#`, de exemplu `0f766e`.
Implicit: culoarea de brand a grupului tău de profiluri, altfel portocaliul Aniva. Butoanele păstrează textul alb,
așa că alege o culoare închisă.

**show\_logo** `boolean`

Afișează logoul grupului tău de profiluri deasupra rezultatelor. Implicit: `true`.

> [!TIP]
>
> Poți adăuga și tu parametrii de aspect la un URL returnat, înainte de fragmentul `#token=`:
> `theme=light|dark`, `primary=<hex>` și `logo=0`. Pagina ignoră orice valoare invalidă.
> Imaginea logoului provine întotdeauna din grupul tău de profiluri, niciodată din URL.

## Răspuns

În caz de succes, API-ul returnează `201 Created`.

**url** `string` *required*

URL-ul paginii. Tokenul de lansare se află în fragmentul `#token=`, astfel încât browserul nu îl trimite niciodată la un
server. Deschide-l o singură dată.

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

Momentul ISO 8601 după care URL-ul nu mai poate fi deschis.

Sesiunea nu este legată de o singură pagină. În interiorul paginii încorporate, utilizatorul poate trece de la Twin la un biomarker și între listă și paginile de detalii. Pagina afișează doar rezultate de laborator: nu afișează valori calculate de Aniva, fișiere, chat sau setări.

## Răspunsuri de eroare

| Status | Descriere |
| - | - |
| `400` | Eroare de validare — ID de profil invalid, `route.name` necunoscut, `biomarker_id` invalid, culoare invalidă sau un `report` fără exact un UUID valid. |
| `403` | Interzis — cheii tale API îi lipsește scope-ul `embed` sau `results_view`, ori scope-ul pentru kituri de testare la domiciliu pentru un raport de comandă de kit de testare la domiciliu, ori profilul este în afara contextului tău de acces. |
| `404` | Profilul nu a fost găsit, niciun biomarker nu are acest `biomarker_id`, `report` nu este o programare, o comandă de kit de testare la domiciliu sau un document încărcat al acestui profil, ori raportul este în afara accesului tău. Acest endpoint returnează `404`, nu `403`, pentru a nu dezvălui că raportul există. |
| `500` | Eroare internă de server. |

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