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

# Vytvořit relaci pro vložení

> Získat jednorázovou URL, která zobrazí laboratorní výsledky profilu ve tvé aplikaci

Získej URL, která zobrazí laboratorní výsledky jednoho profilu jako stránku jen pro čtení. Otevři URL ve WebView své aplikace nebo v kartě prohlížeče. Volej tento endpoint ze svého serveru pokaždé, když uživatel otevře výsledky, a URL nikdy neukládej do mezipaměti.

Vyžaduje oprávnění `embed` a `results_view` u skupiny profilů daného profilu. Aniva uděluje oprávnění `embed` na vyžádání. Bez jednoho z těchto dvou oprávnění požadavek vrátí `403`.

> [!NOTE]
>
> URL funguje jen jednou a platí 5 minut. Po otevření stránka spustí 60minutovou relaci, která
> patří jen této stránce. Archivací svého API klíče zavřeš všechny otevřené stránky najednou.

## Požadavek

### Parametry cesty

**id** `string` *required*

Jedinečný identifikátor (UUID) profilu, jehož výsledky stránka zobrazuje.

### Tělo požadavku

Tělo požadavku je volitelné. Bez něj URL otevře seznam biomarkerů v jazyce profilu.

**language** `string`

Jazyk stránky: `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` nebo `uk`. Výchozí: jazyk profilu.

**route** `object`

Stránka, kterou URL otevře. Výchozí: `{ "name": "biomarkers" }`. Jakékoli jiné `name` vrátí `400`.

**vydané stránky**

**name** `string` *required*

Jedna z hodnot:

* `biomarkers`: seznam všech biomarkerů s jejich nejnovějšími výsledky.
* `biomarker`: stránka s detailem jednoho biomarkeru, jeho trendem, rozmezími a vysvětlením. Vyžaduje `biomarker_id`.
* `twin`: 3D model těla s hodnocením jednotlivých oblastí zdraví. Uživatel si vybere oblast a zobrazí se mu její biomarkery.

**biomarker\_id** `integer`

Pouze pro `biomarker`. Hodnota `biomarker_id` biomarkeru jako ve výsledcích, například `104`. Použij ID, ne slug: slug se může změnit, ID zůstává.

**report** `object`

Omezí každou stránku na jednu laboratorní zprávu profilu. Výchozí: všechny zprávy profilu. Pošli
přesně jedno ze tří ID. Seznam, trend biomarkeru i Twin pak zobrazují výsledky pouze z této
zprávy a stránka skryje filtr termínů. Uživatel s touto URL nemůže otevřít jinou zprávu.

**vlastnosti**

**appointment\_id** `string`

Hodnota `id` termínu profilu. Tvůj klíč k němu musí mít přístup stejně jako u
[Získat laboratorní výsledky](https://docs.anivahealth.com/cs/api/appointments/get-results.md). Pokud nemá, tento endpoint
vrátí `404`, nikoli `403`.

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

Hodnota `id` objednávky domácí testovací sady profilu. Tvůj klíč k ní musí mít přístup
stejně jako u [Získat laboratorní výsledky](https://docs.anivahealth.com/cs/api/home-kit-orders/get-results.md) pro objednávky
domácích testovacích sad a navíc potřebuje `home_kit_orders_view` nebo
`home_kit_orders_manage`.

**document\_id** `string`

Hodnota `id` laboratorní zprávy nahrané pro profil pomocí
[Nahrát dokument](https://docs.anivahealth.com/cs/api/documents/upload-document.md). Tvůj klíč k ní musí mít přístup stejně
jako u [Získat výsledky dokumentu](https://docs.anivahealth.com/cs/api/documents/get-document-results.md). Pokud nemá, tento
endpoint vrátí `404`, nikoli `403`. Stránka zobrazuje datum laboratorního testu, nebo datum
nahrání, pokud ještě není načtena žádná hodnota. Dokud Aniva dokument načítá a nemá ještě
žádnou hodnotu, každá stránka uživatele požádá, aby ji za pár minut otevřel znovu.

**appearance** `object`

Vzhled stránky. API ho přidá do URL jako parametry dotazu.

**vlastnosti**

**theme** `string`

`light` nebo `dark`. Výchozí: systémové nastavení zařízení.

**primary\_color** `string`

Hex barva tlačítek a odkazů, 3 nebo 6 znaků, s `#` nebo bez něj, například `0f766e`.
Výchozí: značková barva tvé skupiny profilů, jinak oranžová barva Aniva. Tlačítka si
zachovávají bílý text, takže vyber tmavou barvu.

**show\_logo** `boolean`

Zobrazit logo tvé skupiny profilů nad výsledky. Výchozí: `true`.

> [!TIP]
>
> Parametry vzhledu můžeš k vrácené URL přidat i ručně, před fragment `#token=`:
> `theme=light|dark`, `primary=<hex>` a `logo=0`. Neplatnou hodnotu stránka ignoruje.
> Obrázek loga vždy pochází z tvé skupiny profilů, nikdy z URL.

## Odpověď

Při úspěchu vrátí API `201 Created`.

**url** `string` *required*

URL stránky. Spouštěcí token je ve fragmentu `#token=`, takže ho prohlížeč nikdy nepošle na
server. Otevři ji jednou.

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

Časový údaj ve formátu ISO 8601, po kterém už URL nelze otevřít.

Relace není vázaná na jednu stránku. Uvnitř vloženého zobrazení může uživatel přejít ze zobrazení Twin na biomarker a mezi seznamem a stránkami s detaily. Stránka zobrazuje pouze laboratorní výsledky: nezobrazuje hodnoty, které Aniva vypočítá, ani soubory, chat nebo nastavení.

## Chybové odpovědi

| Stav | Popis |
| - | - |
| `400` | Chyba validace — neplatné ID profilu, neznámé `route.name`, neplatné `biomarker_id`, neplatná barva nebo `report` bez přesně jednoho platného UUID. |
| `403` | Zakázáno — tvému API klíči chybí oprávnění `embed` nebo `results_view`, případně oprávnění pro domácí testovací sady u zprávy k objednávce domácí testovací sady, nebo je profil mimo tvůj přístupový kontext. |
| `404` | Profil nebyl nalezen, žádný biomarker nemá toto `biomarker_id`, `report` není termín, objednávka domácí testovací sady ani nahraný dokument tohoto profilu, nebo ke zprávě nemáš přístup. Tento endpoint vrací `404`, nikoli `403`, aby neprozradil, že zpráva existuje. |
| `500` | Interní chyba serveru. |

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