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

# Utwórz sesję osadzania

> Pobierz jednorazowy adres URL, który wyświetla wyniki laboratoryjne profilu w twojej aplikacji

Pobierz adres URL, który wyświetla wyniki laboratoryjne jednego profilu jako stronę tylko do odczytu. Otwórz ten adres URL w WebView swojej aplikacji lub w karcie przeglądarki. Wywołuj ten endpoint ze swojego serwera za każdym razem, gdy użytkownik otwiera wyniki, i nigdy nie zapisuj adresu URL w pamięci podręcznej.

Wymaga zakresów `embed` oraz `results_view` w grupie profili danego profilu. Aniva przyznaje zakres `embed` na prośbę. Bez jednego z tych dwóch zakresów żądanie zwraca `403`.

> [!NOTE]
>
> Adres URL działa raz i przez 5 minut. Po otwarciu strona uruchamia 60-minutową sesję, którą
> utrzymuje tylko ta strona. Zarchiwizuj swój klucz API, aby zamknąć wszystkie otwarte strony naraz.

## Żądanie

### Parametry ścieżki

**id** `string` *required*

Unikalny identyfikator (UUID) profilu, którego wyniki pokazuje strona.

### Treść żądania

Treść żądania jest opcjonalna. Bez niej adres URL otwiera listę biomarkerów w języku profilu.

**language** `string`

Język strony: `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` lub `uk`. Domyślnie: język profilu.

**route** `object`

Strona, którą otwiera adres URL. Domyślnie: `{ "name": "biomarkers" }`. Każda inna wartość `name` zwraca `400`.

**udostępnione strony**

**name** `string` *required*

Jedna z wartości:

* `biomarkers`: lista wszystkich biomarkerów z ich najnowszymi wynikami.
* `biomarker`: strona szczegółów jednego biomarkera z jego trendem, zakresami i wyjaśnieniem. Wymaga `biomarker_id`.
* `twin`: ciało 3D z oceną dla każdego obszaru zdrowia. Użytkownik wybiera obszar, aby zobaczyć jego biomarkery.

**biomarker\_id** `integer`

Tylko dla `biomarker`. Identyfikator `biomarker_id` biomarkera, taki jak w wynikach, na przykład `104`. Używaj ID, a nie sluga: slug może się zmienić, ID zostaje.

**report** `object`

Ogranicza każdą stronę do jednego raportu laboratoryjnego profilu. Domyślnie: wszystkie raporty
profilu. Wyślij dokładnie jeden z trzech identyfikatorów. Lista, trend biomarkera i Twin pokazują
wtedy wyłącznie wyniki z tego raportu, a strona ukrywa filtr wizyt. Użytkownik nie może otworzyć
innego raportu za pomocą tego adresu URL.

**właściwości**

**appointment\_id** `string`

Wartość `id` wizyty profilu. Twój klucz musi mieć do niej dostęp, tak jak w przypadku
[Pobierz wyniki laboratoryjne](https://docs.anivahealth.com/pl/api/appointments/get-results.md). Jeśli nie ma, ten endpoint
zwraca `404`, a nie `403`.

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

Wartość `id` zamówienia domowego zestawu testowego profilu. Twój klucz musi mieć do niego
dostęp, tak jak w przypadku [Pobierz wyniki laboratoryjne](https://docs.anivahealth.com/pl/api/home-kit-orders/get-results.md)
dla zamówień domowych zestawów testowych, oraz wymaga zakresu `home_kit_orders_view` lub
`home_kit_orders_manage`.

**document\_id** `string`

Wartość `id` raportu laboratoryjnego przesłanego dla profilu za pomocą
[Prześlij dokument](https://docs.anivahealth.com/pl/api/documents/upload-document.md). Twój klucz musi mieć do niego dostęp, tak
jak w przypadku [Pobierz wyniki z dokumentu](https://docs.anivahealth.com/pl/api/documents/get-document-results.md). Jeśli nie
ma, ten endpoint zwraca `404`, a nie `403`. Strona pokazuje datę badania laboratoryjnego lub
datę przesłania, gdy żadna wartość nie została jeszcze odczytana. Dopóki Aniva odczytuje
dokument i nie ma jeszcze żadnej wartości, każda strona informuje użytkownika, aby otworzył
ją ponownie za kilka minut.

**appearance** `object`

Wygląd strony. API dodaje go do adresu URL jako parametry zapytania.

**właściwości**

**theme** `string`

`light` lub `dark`. Domyślnie: ustawienie systemowe urządzenia.

**primary\_color** `string`

Kolor szesnastkowy przycisków i linków, 3 lub 6 znaków, ze znakiem `#` lub bez niego, na
przykład `0f766e`. Domyślnie: kolor marki twojej grupy profili, w przeciwnym razie
pomarańczowy kolor Aniva. Przyciski zachowują biały tekst, więc wybierz ciemny kolor.

**show\_logo** `boolean`

Pokaż logo twojej grupy profili nad wynikami. Domyślnie: `true`.

> [!TIP]
>
> Parametry wyglądu możesz też samodzielnie dodać do zwróconego adresu URL przed fragmentem
> `#token=`: `theme=light|dark`, `primary=<hex>` i `logo=0`. Strona ignoruje nieprawidłową
> wartość. Obraz logo zawsze pochodzi z twojej grupy profili, nigdy z adresu URL.

## Odpowiedź

W przypadku powodzenia API zwraca `201 Created`.

**url** `string` *required*

Adres URL strony. Token uruchomieniowy znajduje się we fragmencie `#token=`, więc przeglądarka
nigdy nie wysyła go na serwer. Otwórz go raz.

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

Znacznik czasu w formacie ISO 8601, po którym adresu URL nie można już otworzyć.

Sesja nie jest przypisana do jednej strony. W osadzonym widoku użytkownik może przechodzić z Twin do biomarkera oraz między listą a stronami szczegółów. Strona pokazuje wyłącznie wyniki laboratoryjne: nie wyświetla wartości obliczanych przez Aniva, plików, czatu ani ustawień.

## Odpowiedzi z błędami

| Status | Opis |
| - | - |
| `400` | Błąd walidacji — nieprawidłowe ID profilu, nieznana wartość `route.name`, nieprawidłowe `biomarker_id`, nieprawidłowy kolor lub `report` bez dokładnie jednego prawidłowego UUID. |
| `403` | Brak dostępu — twój klucz API nie ma zakresu `embed` lub `results_view`, zakresu domowych zestawów testowych dla raportu z zamówienia domowego zestawu testowego lub profil znajduje się poza twoim kontekstem dostępu. |
| `404` | Nie znaleziono profilu, żaden biomarker nie ma tego `biomarker_id`, `report` nie jest wizytą, zamówieniem domowego zestawu testowego ani przesłanym dokumentem tego profilu lub raport jest poza twoim zakresem dostępu. Ten endpoint zwraca `404`, a nie `403`, aby nie ujawniać, że raport istnieje. |
| `500` | Wewnętrzny błąd serwera. |

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