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

# Crea una sessió d'incrustació

> Obtén un URL d'un sol ús que mostra els resultats de laboratori d'un perfil dins de la teva aplicació

Obtén un URL que mostra els resultats de laboratori d'un perfil com a pàgina de només lectura. Obre l'URL en una WebView de la teva aplicació o en una pestanya del navegador. Crida aquest endpoint des del teu servidor cada vegada que l'usuari obri els resultats i no desis mai l'URL a la memòria cau.

Requereix els permisos `embed` i `results_view` en un grup de perfils del perfil. Aniva concedeix el permís `embed` a petició. Sense un dels dos permisos, la sol·licitud retorna `403`.

> [!NOTE]
>
> L'URL funciona una sola vegada i durant 5 minuts. Quan s'obre, la pàgina inicia una sessió de 60 minuts que
> només manté aquella pàgina. Arxiva la teva clau API per tancar totes les pàgines obertes alhora.

## Sol·licitud

### Paràmetres de ruta

**id** `string` *required*

Identificador únic (UUID) del perfil del qual la pàgina mostra els resultats.

### Cos

El cos és opcional. Sense cos, l'URL obre la llista de biomarcadors en l'idioma del perfil.

**language** `string`

Idioma de la pàgina: `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` o `uk`. Per defecte: l'idioma del perfil.

**route** `object`

La pàgina que obre l'URL. Per defecte: `{ "name": "biomarkers" }`. Qualsevol altre `name` retorna `400`.

**pàgines publicades**

**name** `string` *required*

Un dels següents:

* `biomarkers`: la llista de tots els biomarcadors amb els seus darrers resultats.
* `biomarker`: la pàgina de detall d'un biomarcador, amb la seva tendència, intervals i explicació. Necessita `biomarker_id`.
* `twin`: el cos en 3D amb una puntuació per àrea de salut. L'usuari selecciona una àrea per veure'n els biomarcadors.

**biomarker\_id** `integer`

Només per a `biomarker`. El `biomarker_id` del biomarcador, tal com apareix als resultats, per exemple `104`. Fes servir l'ID, no el slug: un slug pot canviar, l'ID es manté.

**report** `object`

Limita cada pàgina a un sol informe de laboratori del perfil. Per defecte: tots els informes del perfil. Envia
exactament un dels tres ID. La llista, la tendència d'un biomarcador i el Twin mostren llavors els
resultats només d'aquest informe, i la pàgina amaga el filtre de cites. L'usuari no pot obrir
cap altre informe amb aquest URL.

**propietats**

**appointment\_id** `string`

L'`id` d'una cita del perfil. La teva clau hi ha de tenir accés, igual que per a
[Obtenir resultats de laboratori](https://docs.anivahealth.com/ca/api/appointments/get-results.md). Si no en té, aquest endpoint retorna
`404`, no `403`.

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

L'`id` d'una comanda de kit de prova a casa del perfil. La teva clau hi ha de tenir accés, igual que per a
[Obtenir resultats de laboratori](https://docs.anivahealth.com/ca/api/home-kit-orders/get-results.md) per a comandes de kits de prova a casa, i també necessita
`home_kit_orders_view` o `home_kit_orders_manage`.

**document\_id** `string`

L'`id` d'un informe de laboratori que has pujat per al perfil amb
[Pujar un document](https://docs.anivahealth.com/ca/api/documents/upload-document.md). La teva clau hi ha de tenir accés, igual que per a
[Obtenir resultats del document](https://docs.anivahealth.com/ca/api/documents/get-document-results.md). Si no en té, aquest endpoint
retorna `404`, no `403`. La pàgina mostra la data de l'anàlisi de laboratori, o la data de pujada quan
encara no s'ha llegit cap valor. Mentre Aniva llegeix el document i encara no té cap valor, cada pàgina indica
a l'usuari que la torni a obrir al cap d'uns minuts.

**appearance** `object`

L'aspecte de la pàgina. L'API l'afegeix a l'URL com a paràmetres de cerca.

**propietats**

**theme** `string`

`light` o `dark`. Per defecte: la configuració del sistema del dispositiu.

**primary\_color** `string`

Color hexadecimal dels botons i enllaços, de 3 o 6 dígits, amb o sense `#`, per exemple `0f766e`.
Per defecte: el color de marca del teu grup de perfils, o bé el taronja d'Aniva. Els botons mantenen el text blanc,
així que tria un color fosc.

**show\_logo** `boolean`

Mostra el logotip del teu grup de perfils sobre els resultats. Per defecte: `true`.

> [!TIP]
>
> També pots afegir tu mateix els paràmetres d'aspecte a un URL retornat, abans del fragment
> `#token=`: `theme=light|dark`, `primary=<hex>` i `logo=0`. La pàgina ignora qualsevol valor no vàlid.
> La imatge del logotip sempre prové del teu grup de perfils, mai de l'URL.

## Resposta

Si té èxit, l'API retorna `201 Created`.

**url** `string` *required*

L'URL de la pàgina. El token d'inici és al fragment `#token=`, de manera que cap navegador no l'envia mai a un
servidor. Obre'l una sola vegada.

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

Instant en format ISO 8601 a partir del qual ja no es pot obrir l'URL.

La sessió no està vinculada a una sola pàgina. Dins de la vista incrustada, l'usuari pot anar del Twin a un biomarcador i moure's entre la llista i les pàgines de detall. La pàgina mostra només resultats de laboratori: no mostra valors calculats per Aniva, fitxers, xat ni configuració.

## Respostes d'error

| Estat | Descripció |
| - | - |
| `400` | Error de validació — ID de perfil no vàlid, `route.name` desconegut, `biomarker_id` no vàlid, color no vàlid o un `report` sense exactament un UUID vàlid. |
| `403` | Prohibit — a la teva clau API li falta l'àmbit `embed` o `results_view`, o l'àmbit de kit de prova a casa per a un informe de comanda de kit de prova a casa, o el perfil queda fora del teu context d'accés. |
| `404` | Perfil no trobat, o cap biomarcador no té aquest `biomarker_id`, o el `report` no és una cita, una comanda de kit de prova a casa ni un document pujat d'aquest perfil, o l'informe queda fora del teu accés. Aquest endpoint retorna `404`, no `403`, per no mostrar que l'informe existeix. |
| `500` | Error intern del servidor. |

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