Что ты можешь делать
- Управление профилями — создавай, получай и обновляй демографические профили пациентов.
- Планирование записей — оформляй записи на забор крови в пунктах сдачи анализов Aniva.
- Управление панелями — добавляй или удаляй лабораторные панели в существующей записи.
- Отдельные биомаркеры — добавляй или удаляй отдельные биомаркеры в записи без выбора панели.
- Заказы наборов для домашнего теста — отправляй пациенту набор для домашнего теста по почте, отслеживай посылки и сообщай, когда образец собран.
- Каталог панелей — просматривай доступные панели с помощью
GET /api/v1/panels, чтобы узнать ID панелей и входящие в них биомаркеры. - Каталог биомаркеров — просматривай биомаркеры, которые можно заказать в локации или в наборе для домашнего теста, с помощью
GET /api/v1/biomarkers, чтобы узнать их ID. - Подтверждение забора крови — отправляй лабораторный код (или коды) после забора крови, чтобы запустить пайплайн лабораторного заказа.
- Лабораторные результаты — получай клинические и генетические результаты и скачивай PDF-файлы лабораторных отчетов.
- Поиск локаций — получай список доступных пунктов сдачи анализов, чтобы показывать их пациентам.
- Логистика отправок — создавай, отслеживай, изменяй и отменяй заказы на курьерскую доставку.
- Вебхуки — получай HTTPS-запрос при изменении записи, заказа набора для домашнего теста, его результатов, локации, профиля или отправки. См. Вебхуки.
Изучи документацию
Аутентификация
Аутентифицируй запросы с помощью своего партнерского API-ключа.
Быстрый старт
Сделай первый вызов API за несколько минут с помощью пошаговых примеров.
Профили
Узнай, как работают профили пациентов и какие данные в них хранятся.
Записи
Разберись в жизненном цикле записи — от планирования до подтверждения.
Заказы наборов для домашнего теста
Отправь набор для теста пациенту на дом и отслеживай его, пока образец не дойдет до лаборатории.
Версионирование API
Текущая версия API — v1. Все эндпоинты начинаются с префикса/api/v1/. Базовый URL — https://anivahealth.com.
Даты и часовые пояса
Все моменты времени при передаче имеют формат UTC ISO 8601 (суффиксZ). Календарные поля используют компоненты местного
времени (YYYY-MM-DD, HH:MM).
Особые примечания:
- Входные параметры с датой и временем (например,
scheduled_atвPOST/PATCH /api/v1/appointments) должны содержать указатель часового пояса — либоZ, либо явное смещение, например+02:00. Даты со временем без часового пояса отклоняются с кодом400. Обе формы кодируют один и тот же момент времени; в ответеscheduled_atвсегда возвращается в UTCZ. Используй полеtimezoneлокации (или любой другой идентификатор IANA), чтобы отформатировать момент времени в местное время при отображении. - Входные значения местного времени интерпретируются в часовом поясе целевого ресурса: даты
доступности используют query-параметр
timezone(по умолчанию — часовой пояс локации);pickup_date/pickup_time_*отправки интерпретируются в часовом поясе локации отправления. - Поля ответа только с датой (например,
tested_at,availability[].dateдоступности) — это календарные даты без часового пояса.
Получение доступа
Aniva выдает API-ключи для каждого партнера отдельно.Свяжись с Aniva, чтобы получить партнерский API-ключ.