> ## 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 — REST API для аналізів крові в аптеках і медичних кабінетах, наборів для домашнього тесту та лабораторних результатів.

Aniva Partner API — це REST API, який дає змогу медичним партнерам керувати профілями пацієнтів, планувати записи на забір крові в локаціях тестування та запускати процеси лабораторних замовлень. Ти взаємодієш з API через HTTPS за допомогою свого партнерського ключа API.

## Що ти можеш робити

* **Керування профілями** — Створюй, отримуй та оновлюй демографічні профілі пацієнтів.
* **Планування записів** — Бронюй записи на забір крові в локаціях тестування Aniva.
* **Керування панелями** — Додавай або видаляй панелі лабораторних аналізів у наявному записі.
* **Окремі біомаркери** — Додавай або прибирай окремі біомаркери в записі без вибору панелі.
* **Замовлення наборів для домашнього тесту** — Надсилай пацієнту набір для домашнього тесту поштою, відстежуй його посилки та повідомляй, коли зразок зібрано.
* **Каталог панелей** — Переглядай доступні панелі через `GET /api/v1/panels`, щоб дізнатися ID панелей і склад біомаркерів.
* **Каталог біомаркерів** — Переглядай біомаркери, які можна замовити в локації або в наборі для домашнього тесту, через `GET /api/v1/biomarkers`, щоб дізнатися їхні ID.
* **Підтвердження забору крові** — Надсилай лабораторний код (або коди) після забору крові, щоб запустити процес лабораторного замовлення.
* **Лабораторні результати** — Отримуй клінічні та генетичні результати й завантажуй PDF-файли лабораторних звітів.
* **Пошук локацій** — Отримуй список доступних локацій тестування, щоб показати їх пацієнтам.
* **Логістика відправлень** — Створюй, відстежуй, змінюй і скасовуй замовлення на кур’єрську доставку.
* **Вебхуки** — Отримуй HTTPS-виклик, коли змінюється запис, замовлення набору для домашнього тесту, його результати, локація, профіль або відправлення. Див. [Вебхуки](https://docs.anivahealth.com/uk/concepts/webhooks.md).

## Ознайомся з документацією

> [card] [Автентифікація](https://docs.anivahealth.com/uk/authentication.md)
>
> Автентифікуй запити за допомогою свого партнерського ключа API.

> [card] [Швидкий старт](https://docs.anivahealth.com/uk/quickstart.md)
>
> Зроби свій перший виклик API за кілька хвилин із покроковими прикладами.

> [card] [Профілі](https://docs.anivahealth.com/uk/concepts/profiles.md)
>
> Дізнайся, як працюють профілі пацієнтів і які дані вони містять.

> [card] [Записи](https://docs.anivahealth.com/uk/concepts/appointments.md)
>
> Зрозумій життєвий цикл запису від планування до підтвердження.

> [card] [Замовлення наборів для домашнього тесту](https://docs.anivahealth.com/uk/concepts/home-kit-orders.md)
>
> Надішли набір для тестування пацієнту додому та відстежуй його, доки зразок не надійде до лабораторії.

## Версіонування API

Поточна версія API — **v1**. Усі ендпоінти мають префікс `/api/v1/`. Базовий URL — `https://anivahealth.com`.

```text theme={null}
https://anivahealth.com/api/v1/
```

Зміни, що порушують сумісність, впроваджуватимуться під новим префіксом версії. API v1 залишатиметься доступним із завчасним попередженням про будь-яке припинення підтримки.

## Дати й часові пояси

Усі моменти часу під час передачі подаються у форматі **UTC ISO 8601** (суфікс `Z`). Суто календарні поля використовують **складові
місцевого часу** (`YYYY-MM-DD`, `HH:MM`).

| Категорія | Формат | Для чого використовується |
| - | - | - |
| **Момент часу** | ISO 8601 в UTC (суфікс `Z`, наприклад `2026-04-15T08:30:00Z`) | Усі значення дати й часу у відповідях — `scheduled_at` запису, `slots[]` доступності, `pickup.from` / `pickup.till` відправлення, `created_at`, `updated_at`, `added_at`. Відображай у будь-якому місцевому часовому поясі на стороні клієнта. |
| **Подія провайдера** | ISO 8601 зі зміщенням зовнішнього провайдера (передається без змін) | Лише `status_updates[].time` відправлення — зміщення відповідає тому, що повідомив кур’єр. |
| **Місцевий час** | `YYYY-MM-DD` для дат, `HH:MM` для часу — без зміщення | Суто календарні значення або час доби — `date_of_birth`, `tested_at` результатів, `start_date` / `end_date` доступності, `pickup_date` / `pickup_time_from` / `pickup_time_till` відправлення, `open_hours` локації. |

Окремі примітки:

* **Вхідні поля дати й часу** (наприклад, `scheduled_at` у `POST` / `PATCH /api/v1/appointments`)
  **мають містити позначення часового поясу** — `Z` або явне зміщення, як-от `+02:00`. Значення
  без часового поясу відхиляються з кодом `400`. Обидві форми кодують той самий момент часу; у
  відповіді `scheduled_at` завжди повертається у форматі UTC `Z`. Використовуй поле `timezone`
  локації (або будь-який інший ідентифікатор IANA), щоб відформатувати момент часу в місцевий час
  під час відображення.
* **Вхідні поля місцевого часу** інтерпретуються в часовому поясі цільового ресурсу: для дат
  доступності використовується параметр запиту `timezone` (типово — часовий пояс локації); для
  `pickup_date` / `pickup_time_*` відправлення — часовий пояс локації відправлення.
* **Поля відповідей лише з датою** (наприклад, `tested_at`, `availability[].date` доступності) —
  це календарні дати без часового поясу.

## Отримання доступу

Aniva видає ключі API окремо для кожного партнера.

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


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