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

# Створити сесію вбудовування

> Отримати одноразовий URL, який показує лабораторні результати профілю в твоєму застосунку

Отримай URL, який показує лабораторні результати одного профілю як сторінку лише для читання. Відкрий цей URL у WebView свого застосунку або у вкладці браузера. Викликай цей ендпоінт зі свого сервера щоразу, коли користувач відкриває результати, і ніколи не кешуй URL.

Потрібні дозволи `embed` і `results_view` для групи профілів цього профілю. Aniva надає дозвіл `embed` за запитом. Без одного з цих двох дозволів запит повертає `403`.

> [!NOTE]
>
> URL працює один раз і діє 5 хвилин. Після відкриття сторінка запускає 60-хвилинну сесію, яка
> діє лише для цієї сторінки. Заархівуй свій API-ключ, щоб закрити всі відкриті сторінки одразу.

## Запит

### Параметри шляху

**id** `string` *required*

Унікальний ідентифікатор (UUID) профілю, результати якого показує сторінка.

### Тіло запиту

Тіло запиту необов’язкове. Без нього URL відкриває список біомаркерів мовою профілю.

**language** `string`

Мова сторінки: `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` або `uk`. Типово: мова профілю.

**route** `object`

Сторінка, яку відкриває URL. Типово: `{ "name": "biomarkers" }`. Будь-яке інше значення `name` повертає `400`.

**доступні сторінки**

**name** `string` *required*

Одне зі значень:

* `biomarkers`: список усіх біомаркерів з їхніми останніми результатами.
* `biomarker`: сторінка одного біомаркера з його динамікою, діапазонами та поясненням. Потребує `biomarker_id`.
* `twin`: 3D-тіло з оцінкою для кожної сфери здоров’я. Користувач обирає сферу, щоб переглянути її біомаркери.

**biomarker\_id** `integer`

Лише для `biomarker`. Значення `biomarker_id` біомаркера, як у результатах, наприклад `104`. Використовуй ID, а не slug: slug може змінитися, а ID залишається незмінним.

**report** `object`

Обмежує кожну сторінку одним лабораторним звітом профілю. Типово: усі звіти профілю. Надішли
рівно один із трьох ID. Тоді список, динаміка біомаркера та Twin показують
результати лише цього звіту, а сторінка приховує фільтр записів. Користувач не може відкрити
інший звіт за цим URL.

**властивості**

**appointment\_id** `string`

Значення `id` запису профілю. Твій ключ має мати доступ до нього, як і для
[Отримати лабораторні результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md). Якщо доступу немає, цей ендпоінт повертає
`404`, а не `403`.

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

Значення `id` замовлення набору для домашнього тесту цього профілю. Твій ключ має мати доступ до нього, як і для
[Отримати лабораторні результати](https://docs.anivahealth.com/uk/api/home-kit-orders/get-results.md) для замовлень наборів для домашнього тесту, а також потребує
`home_kit_orders_view` або `home_kit_orders_manage`.

**document\_id** `string`

Значення `id` лабораторного звіту, завантаженого тобою для профілю через
[Завантажити документ](https://docs.anivahealth.com/uk/api/documents/upload-document.md). Твій ключ має мати доступ до нього, як і для
[Отримати результати документа](https://docs.anivahealth.com/uk/api/documents/get-document-results.md). Якщо доступу немає, цей ендпоінт
повертає `404`, а не `403`. Сторінка показує дату лабораторного аналізу або дату завантаження, якщо
жодного значення ще не зчитано. Поки Aniva зчитує документ і значень ще немає, кожна сторінка просить
користувача відкрити її знову за кілька хвилин.

**appearance** `object`

Зовнішній вигляд сторінки. API додає його до URL як параметри запиту.

**властивості**

**theme** `string`

`light` або `dark`. Типово: системне налаштування пристрою.

**primary\_color** `string`

Hex-колір кнопок і посилань, 3 або 6 символів, із `#` або без нього, наприклад `0f766e`.
Типово: фірмовий колір твоєї групи профілів, інакше помаранчевий колір Aniva. Текст на кнопках завжди білий,
тому обирай темний колір.

**show\_logo** `boolean`

Показувати логотип твоєї групи профілів над результатами. Типово: `true`.

> [!TIP]
>
> Ти також можеш самостійно додати параметри вигляду до отриманого URL перед фрагментом `#token=`:
> `theme=light|dark`, `primary=<hex>` і `logo=0`. Сторінка ігнорує некоректне значення.
> Зображення логотипа завжди береться з твоєї групи профілів, а не з URL.

## Відповідь

У разі успіху API повертає `201 Created`.

**url** `string` *required*

URL сторінки. Токен запуску міститься у фрагменті `#token=`, тому браузер ніколи не надсилає його на
сервер. Відкрий його один раз.

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

Момент часу у форматі ISO 8601, після якого URL неможливо відкрити.

Сесія не прив’язана до однієї сторінки. Усередині вбудованого інтерфейсу користувач може переходити з Twin до біомаркера, а також між списком і детальними сторінками. Сторінка показує лише лабораторні результати: вона не відображає значення, які розраховує Aniva, файли, чат чи налаштування.

## Відповіді з помилками

| Статус | Опис |
| - | - |
| `400` | Помилка валідації — некоректний ID профілю, невідоме значення `route.name`, некоректний `biomarker_id`, некоректний колір або `report` без рівно одного коректного UUID. |
| `403` | Доступ заборонено — твій API-ключ не має дозволу `embed` або `results_view`, або дозволу на набір для домашнього тесту для звіту за його замовленням, або профіль поза твоїм контекстом доступу. |
| `404` | Профіль не знайдено, або жоден біомаркер не має такого `biomarker_id`, або `report` не є записом, замовленням набору для домашнього тесту чи завантаженим документом цього профілю, або звіт поза твоїм доступом. Цей ендпоінт повертає `404`, а не `403`, щоб не розкривати існування звіту. |
| `500` | Внутрішня помилка сервера. |

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