Заказы наборов для домашнего теста
Отправить результаты по электронной почте
Отправить клиенту письмо о готовности лабораторных результатов его набора для домашнего теста
POST
/
api
/
v1
/
home-kit-orders
/
{id}
/
results
/
email
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
Отправь клиенту одно письмо о том, что лабораторные результаты готовы. Письмо отправляется на
email профиля из заказа набора для домашнего теста.
В письме используется общий брендинг партнёра: название и логотип основной группы профилей
этого профиля. Язык письма — language профиля, по умолчанию английский.
Установи для with_reports значение true, чтобы прикрепить лабораторные отчёты по набору. К письму
прикрепляется каждый отчёт, который клиент видит в приложении. Установи false, чтобы
отправить только уведомление. Добавь note, чтобы показать в письме личную заметку, не более 1 000 символов.
Каждый прикреплённый отчёт — это PDF-файл, зашифрованный с помощью AES-256. Пароль — поле date_of_birth
профиля в виде 8 цифр, DDMMYYYY, без точек: клиент, родившийся 1 февраля 1985 года, вводит
01021985. В письме клиенту сообщается этот формат, но никогда не указывается сама дата рождения.
Каждый вызов отправляет одно письмо. Вызовы не дедуплицируются: если ты вызовешь эндпоинт дважды, клиент
получит два письма.
Письмо не отправляется, если:
- Лабораторный отчёт ещё не поступил.
- В профиле нет адреса электронной почты или указан только адрес-заглушка
@aniva.email. - В профиле отключены транзакционные письма. Чтобы снова их включить, установи
для
transactional_emails_enabledзначениеtrueчерез Обновить профиль. with_reportsимеет значениеtrue, а в профиле нетdate_of_birth. Задай это значение через Обновить профиль или отправь запрос сwith_reports: false.- Это один из демозаказов набора для домашнего теста. У демозаказа нет клиента, которому можно отправить письмо.
results_view, а также разрешение home_kit_orders_view или home_kit_orders_manage.
Запрос
Параметры пути
Уникальный идентификатор (UUID) заказа набора для домашнего теста, результаты которого нужно отправить по почте.
Параметры тела запроса
true прикрепляет лабораторные отчёты в виде PDF-файлов, защищённых паролем. false отправляет только уведомление о готовности
результатов.Ответ
При успехе API возвращает200 OK.
Количество прикреплённых лабораторных отчётов.
0, если with_reports имеет значение false.Ответы с ошибками
Тело ошибки содержитerror (понятное человеку сообщение) и reason (стабильный код). У ошибок валидации
и при отсутствии права доступа results_view поле reason отсутствует.
| Статус | Причина | Описание |
|---|---|---|
400 | — | Ошибка валидации — неверный ID, отсутствует with_reports или note длиннее 1 000 символов. |
403 | access_denied | Доступ запрещён — у твоего API-ключа нет нужных разрешений или заказ набора для домашнего теста находится вне твоего контекста доступа. |
404 | not_found | Заказ набора для домашнего теста не найден. |
409 | demo_order | Это демозаказ набора для домашнего теста. У него нет клиента, которому можно отправить письмо. |
409 | no_reports | Лабораторный отчёт ещё не поступил. |
409 | no_email | В профиле нет адреса электронной почты. |
409 | placeholder_email | В профиле указан только адрес-заглушка @aniva.email. Обнови профиль, указав настоящий адрес электронной почты. |
409 | unsubscribed | В профиле отключены транзакционные письма. Сначала установи для transactional_emails_enabled значение true. |
409 | no_birthdate | with_reports имеет значение true, а в профиле нет date_of_birth — пароля для PDF. |
413 | reports_too_large | Отчёты слишком велики для одного письма. Отправь письмо с with_reports: false. |
422 | report_unprotectable | Отчёт не в формате PDF или его не удалось защитить паролем. Отправь с with_reports: false. |
500 | — | Внутренняя ошибка сервера. |
502 | report_unavailable | Не удалось загрузить лабораторный отчёт. Письмо не отправлено. |
502 | send_failed | Почтовый провайдер отклонил письмо. Письмо не отправлено. |
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}
⌘I
curl --request POST \
--url https://anivahealth.com/api/v1/home-kit-orders/d1e2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f5a/results/email \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"with_reports": true
}'
{
"recipient_email": "maria.schmidt@example.com",
"attachment_count": 1,
"sent_at": "2026-10-15T09:12:44.512Z"
}
{
"error": "No lab report has arrived yet.",
"reason": "no_reports"
}