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

# Швидкий старт

> Зроби перший запит до Aniva Partner API за кілька хвилин: знайди локацію тестування, створи профіль і забронюй забір крові.

Цей посібник проведе тебе через основний процес: пошук локації тестування, створення профілю пацієнта, планування запису та підтвердження забору крові.

## Передумови

Тобі потрібен партнерський ключ API, виданий Aniva.

> [!NOTE]
>
> Якщо в тебе ще немає ключа API, звернися до Aniva, щоб його видали для твого партнерського акаунта.

## Кроки

**1. Отримати список доступних локацій**

Отримай список локацій тестування, щоб знайти `location_id` для запису, який плануватимеш.

```bash theme={null}
curl https://anivahealth.com/api/v1/locations \
  -H "x-api-key: YOUR_API_KEY"
```

**Приклад відповіді**

```json theme={null}
[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Aniva Berlin Mitte",
    "company_name": "Aniva GmbH",
    "street": "Unter den Linden",
    "house_number": "42",
    "address_line_2": null,
    "city": "Berlin",
    "state": "Berlin",
    "postal_code": "10117",
    "country_name": "Germany",
    "country_code": "DE",
    "timezone": "Europe/Berlin",
    "contact_phone": "+4930987654321",
    "email": "berlin-mitte@anivahealth.com",
    "website": "https://anivahealth.com",
    "google_maps_url": null,
    "image_url": null,
    "open_hours": {
      "monday": [{ "open": "08:00", "close": "18:00" }],
      "tuesday": [{ "open": "08:00", "close": "18:00" }],
      "wednesday": [{ "open": "08:00", "close": "18:00" }],
      "thursday": [{ "open": "08:00", "close": "18:00" }],
      "friday": [{ "open": "08:00", "close": "16:00" }],
      "saturday": [],
      "sunday": []
    }
  }
]
```

Запиши `id` локації, яку хочеш використати. Він знадобиться тобі на кроці 3.

**2. Створити профіль**

Створи профіль пацієнта, надіславши його демографічні дані. Поле `profile_group` прив’язує профіль до твого партнерського акаунта — воно приймає або незмінний UUID групи, або її зручний для читання slug.

```bash theme={null}
curl -X POST https://anivahealth.com/api/v1/profiles \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jordan",
    "last_name": "Rivera",
    "sex": 1,
    "date_of_birth": "1990-04-15",
    "profile_group": "your-profile-group"
  }'
```

**Поля тіла запиту**

| Поле | Тип | Обов’язкове | Опис |
| - | - | - | - |
| `first_name` | string | Так | Ім’я пацієнта |
| `last_name` | string | Так | Прізвище пацієнта |
| `sex` | integer | Так\*\* | `1` = чоловіча, `2` = жіноча (ISO/IEC 5218) |
| `date_of_birth` | string | Так\*\* | Дата народження у форматі `YYYY-MM-DD`. Має бути в минулому, не раніше 1900 року, і відповідати віку 16–100 років. |
| `profile_group` | string | Так\* | UUID або slug твоєї партнерської групи профілів. UUID є стабільним посиланням; slug також приймається. |
| `profile_group_slug` | string | Ні | **Застаріле.** Псевдонім slug для `profile_group`. Потрібно вказати `profile_group` або `profile_group_slug`. |
| `email` | string | Ні | Електронна пошта пацієнта. Генерується автоматично, якщо не вказано. |
| `language` | string | Ні | `en`, `de` або `fi`. Типово `en`. |
| `phone` | string | Ні | Номер телефону у форматі E.164, наприклад `+4915123456789`. |
| `height` | number | Ні | Зріст у сантиметрах. |
| `weight` | number | Ні | Вага в кілограмах. |
| `transactional_emails_enabled` | boolean | Ні | Перевизначає типове налаштування групи профілів для службових листів. |
| `marketing_emails_enabled` | boolean | Ні | Перевизначає типове налаштування групи профілів для маркетингових листів. |

\*\* Необов’язково, якщо твоя група профілів дозволяє пацієнту ввести обидва значення на сторінці активації набору. Див.
[Профілі](https://docs.anivahealth.com/uk/concepts/profiles.md#dozvoliti-patsiyentu-vvesti-datu-narodzhennya-i-stat).

**Приклад відповіді (201 Created)**

```json theme={null}
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "handle": null,
  "first_name": "Jordan",
  "last_name": "Rivera",
  "email": "jordan.rivera@example.com",
  "phone": null,
  "sex": 1,
  "date_of_birth": "1990-04-15",
  "height": null,
  "weight": null,
  "language": "en",
  "transactional_emails_enabled": null,
  "created_at": "2026-04-01T10:00:00Z",
  "updated_at": null
}
```

Запиши `id` із відповіді. Ти використаєш його як `profile_id` на наступному кроці.

**3. Запланувати запис**

Створи запис, використовуючи `profile_id` із кроку 2 і `location_id` із кроку 1. Вкажи для `scheduled_at` початок слота, який повертає [Отримати доступність](https://docs.anivahealth.com/uk/api/locations/get-availability.md) для цієї локації. API відхиляє час, що не відповідає сітці слотів.

```bash theme={null}
curl -X POST https://anivahealth.com/api/v1/appointments \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "profile_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "location_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "scheduled_at": "2026-04-10T09:00:00Z"
  }'
```

**Приклад відповіді (201 Created)**

```json theme={null}
{
  "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "profile_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "location_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "scheduled_at": "2026-04-10T09:00:00Z",
  "status": "confirmed",
  "cancellation_reason": null,
  "results_ready_emails": [],
  "created_at": "2026-04-01T10:05:00Z",
  "updated_at": null,
  "profile": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "handle": null,
    "first_name": "Jordan",
    "last_name": "Rivera",
    "email": "jordan.rivera@example.com",
    "phone": null,
    "sex": 1,
    "date_of_birth": "1990-04-15",
    "height": null,
    "weight": null,
    "language": "en",
    "transactional_emails_enabled": null,
    "created_at": "2026-04-01T10:00:00Z",
    "updated_at": null
  },
  "panels": [],
  "individual_biomarkers": [],
  "shipments": [],
  "lab_codes": []
}
```

Запиши `id` запису. Ти використаєш його для підтвердження забору крові.

**4. Підтвердити забір крові**

Після завершення забору крові надішли лабораторний код (штрихкод пробірки), щоб підтвердити забір крові та запустити процес лабораторного замовлення. Якщо на пробірках під час забору крові є кілька кодів, натомість передай `lab_codes` — див. [Підтвердити забір крові](https://docs.anivahealth.com/uk/api/appointments/confirm-blood-draw.md).

```bash theme={null}
curl -X POST https://anivahealth.com/api/v1/appointments/c3d4e5f6-a7b8-9012-cdef-123456789012/confirm \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lab_code": "7642001234"
  }'
```

**Приклад відповіді (200 OK)**

```json theme={null}
{
  "success": true
}
```

Після підтвердження запускається процес лабораторного замовлення. Ти можеш отримати запис, щоб переконатися, що його статус змінився на `"blood_drawn"`.

## Наступні кроки

* [Додай панелі до запису](https://docs.anivahealth.com/uk/api/appointments/add-panels.md), щоб указати, які лабораторні аналізи провести.
* [Онови запис](https://docs.anivahealth.com/uk/api/appointments/update-appointment.md), щоб перенести його або змінити локацію до забору крові.
* [Скасуй запис](https://docs.anivahealth.com/uk/api/appointments/cancel-appointment.md), якщо він більше не потрібен.
* [Отримай лабораторні результати](https://docs.anivahealth.com/uk/api/appointments/get-results.md), щоб завантажити клінічні та генетичні результати після опрацювання.
* [Завантаж документи](https://docs.anivahealth.com/uk/api/documents/download-document.md), щоб отримати PDF-файли лабораторних звітів.
* [Отримай профіль](https://docs.anivahealth.com/uk/api/profiles/get-profile.md), щоб перевірити або показати дані пацієнта.
* Переглянь повний [довідник API](https://docs.anivahealth.com/uk/api/profiles/create-profile.md) з усіма доступними ендпоінтами та параметрами.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.