UDENTIVA Умная платформа управления стоматологией

РАЗРАБОТЧИКИ

Документация API UDENTIVA

Безопасно интегрируйте данные вашей клиники с собственными системами. API на основе REST, согласованный и предсказуемый.

Внешний доступ к API скоро откроется

Ниже приведён полный набор конечных точек, которые будут открыты наружу. Для раннего доступа свяжитесь с нами.

Модель безопасности API

Изоляция данных, идемпотентная запись, параметризованный запрос — безопасность, опирающаяся на код. →

Обзор

API UDENTIVA следует принципам REST; использует тело JSON и возвращает стандартные коды состояния HTTP. Все запросы выполняются по HTTPS и аутентифицируются ключом API. Каждый запрос ограничен данными клиники, к которой привязан ключ (полная изоляция данных).

Базовый адрес:

https://api.udentiva.com

Аутентификация

В запросах передавайте ваш ключ API в заголовке Authorization. Ключи генерируются через панель клиники и могут быть аннулированы в любой момент.

# Пример запроса
curl https://api.udentiva.com/v1/patients \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Accept: application/json"

Конечные точки

81 конечная точка · 12 источник

Ниже приведены все конечные точки, которые будут открыты наружу. На странице подробностей каждого ресурса есть параметры, пример запроса/ответа и заметки по безопасности. Точки записи поддерживают заголовок Idempotency-Key.

Пациенты · 9

Подробности и пример →

GET /v1/patients Возвращает список пациентов с постраничной разбивкой

POST /v1/patients Создаёт запись нового пациента

GET /v1/patients/{id} Возвращает детали одного пациента

PUT /v1/patients/{id} Обновляет информацию о пациенте

DELETE /v1/patients/{id} Архивирует пациента (soft-delete)

GET /v1/patients/{id}/medical Выводит список анамнеза, аллергий и медицинской истории

POST /v1/patients/{id}/medical Добавляет медицинскую запись/анамнез

GET /v1/patients/{id}/documents Выводит список документов пациента

POST /v1/patients/{id}/documents Добавляет документ к пациенту

Записи на приём и календарь · 10

Подробности и пример →

GET /v1/appointments Выводит список приёмов по диапазону дат

POST /v1/appointments Создаёт новый приём (с проверкой конфликтов)

POST /v1/appointments/{id}/status Изменяет статус приёма

POST /v1/appointments/{id}/reschedule Переносит приём на другое время

POST /v1/appointments/{id}/remind Отправляет напоминание о приёме

GET /v1/units Выводит список кресел/установок

GET /v1/doctors Выводит список врачей

GET /v1/waitlist Возвращает список ожидания

POST /v1/waitlist Добавляет пациента в список ожидания

DELETE /v1/waitlist/{id} Удаляет из списка ожидания

Одонтограмма и лечение · 14

Подробности и пример →

GET /v1/patients/{id}/odontogram Возвращает актуальную зубную карту FDI

POST /v1/patients/{id}/odontogram Добавляет состояние зуба (append-only)

GET /v1/patients/{id}/odontogram/{tooth}/history Возвращает историю состояний зуба

GET /v1/services Выводит каталог услуг/процедур

POST /v1/services Добавляет позицию услуги

PUT /v1/services/{id} Обновляет позицию услуги

GET /v1/patients/{id}/plans Выводит список планов лечения пациента

POST /v1/patients/{id}/plans Создаёт план лечения

GET /v1/plans/{id} Возвращает детали плана лечения

POST /v1/plans/{id}/status Изменяет статус плана

POST /v1/plans/{id}/items Добавляет этап/позицию в план

POST /v1/plan-items/{id}/status Изменяет статус позиции плана

GET /v1/patients/{id}/prescriptions Выводит список рецептов

POST /v1/patients/{id}/prescriptions Создаёт рецепт

Инкассация и финансы · 12

Подробности и пример →

POST /v1/invoices Создаёт счёт

GET /v1/invoices Выводит список счетов

GET /v1/invoices/{id} Возвращает детали счёта

POST /v1/invoices/{id}/void Аннулирует счёт (сторнирующая запись)

POST /v1/invoices/{id}/einvoice Отправляет счёт как e-Fatura (GİB)

GET /v1/einvoices Выводит список записей e-Fatura

POST /v1/payments Регистрирует оплату (идемпотентно)

GET /v1/patients/{id}/balance Возвращает сальдо взаиморасчётов пациента

GET /v1/patients/{id}/ledger Выводит список операций по взаиморасчётам пациента

GET /v1/cash/day Возвращает кассовую сводку на конец дня

GET /v1/cari Выводит список текущих сальдо взаиморасчётов

GET /v1/billing/summary Возвращает сводку по финансам/оплатам

Склад · 6

Подробности и пример →

GET /v1/stock Выводит список складских карточек

GET /v1/stock/critical Выводит список запасов с критическим уровнем

POST /v1/stock Создаёт складскую карточку

PUT /v1/stock/{id} Обновляет складскую карточку

POST /v1/stock/{id}/movement Добавляет движение по складу (приход/расход)

GET /v1/stock/{id}/movements Выводит список движений по складу

Снимки · 3

Подробности и пример →

GET /v1/patients/{id}/images Выводит список изображений пациента (рентген/фото)

POST /v1/patients/{id}/images Загружает изображение (S3, stream/presigned)

GET /v1/images/{id}/raw Скачивает файл изображения (presigned)

Лаборатория · 7

Подробности и пример →

GET /v1/lab-orders Выводит список заказов в лабораторию

POST /v1/lab-orders Создаёт заказ в лабораторию

GET /v1/lab-orders/{id} Возвращает детали заказа

PUT /v1/lab-orders/{id} Обновляет заказ

POST /v1/lab-orders/{id}/status Изменяет статус заказа

GET /v1/labs Выводит список партнёрских лабораторий

POST /v1/labs Добавляет лабораторию

Lead и CRM · 7

Подробности и пример →

GET /v1/leads Выводит список lead/запросов

POST /v1/leads Создаёт новый lead

POST /v1/leads/{id}/status Изменяет статус/этап lead

GET /v1/tasks Выводит список задач

POST /v1/tasks Создаёт задачу

GET /v1/messages Выводит список сообщений коммуникации с пациентом

POST /v1/messages Создаёт запись сообщения/коммуникации

Медицинский туризм · 5

Подробности и пример →

GET /v1/tourism-cases Выводит список случаев медицинского туризма

POST /v1/tourism-cases Создаёт туристический случай

POST /v1/tourism-cases/{id}/status Изменяет этап случая

GET /v1/shipments Выводит список записей о переводах/трансферах

POST /v1/shipments Создаёт запись о переводе/трансфере

Отчётность и BI · 3

Подробности и пример →

GET /v1/bi Возвращает метрики бизнес-аналитики

GET /v1/profit Возвращает отчёт о рентабельности

GET /v1/rcm Возвращает метрики цикла доходов (RCM)

Webhooks · 3

Подробности и пример →

GET /v1/webhooks Выводит список зарегистрированных подписок webhook

POST /v1/webhooks Регистрирует webhook для уведомления о событиях

DELETE /v1/webhooks/{id} Удаляет подписку webhook

Передача данных (Export API) · 2

Подробности и пример →

GET /export/v1 Возвращает разрешённые для ключа наборы данных и информацию об использовании (обнаружение)

GET /export/v1/{dataset} Извлекает выбранный набор данных с постраничной разбивкой (?limit=1000&offset=0)

Формат ошибки

Ошибки возвращаются в согласованном конверте; код — для машины, сообщение — для пользователя. Внутренняя ошибка/стек никогда не утекает.

{
  "error": {
    "code": "validation_failed",
    "message": "Недопустимое поле: e-mail"
  }
}

Ограничение скорости

Запросы ограничены в минуту. При превышении лимита возвращается 429; в заголовках ответа передаётся информация об остатке квоты.

Версионирование

Версия API передаётся в пути (например, /v1). Изменения, нарушающие обратную совместимость, выходят под новой версией.

События Webhook

По мере наступления событий в вашей клинике на зарегистрированный адрес отправляется подписанное уведомление. Так вы держите собственную систему актуальной в реальном времени.

# Типы примеров событий
patient.created   appointment.created   appointment.status_changed
invoice.created   payment.created       lab_order.status_changed
treatment_plan.updated   lead.created   tourism_case.status_changed

Хотите ранний доступ?

Узнайте об открытии API первыми.

Связаться