> ## 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/ru/api/appointments/get-results.md). Если доступа нет, этот
эндпоинт возвращает `404`, а не `403`.

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

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

**document\_id** `string`

Поле `id` лабораторного отчёта, загруженного для профиля через
[Загрузить документ](https://docs.anivahealth.com/ru/api/documents/upload-document.md). У твоего ключа должен быть к нему доступ,
как для [Получить результаты документа](https://docs.anivahealth.com/ru/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.