Клиника дерегіңізді өз жүйелеріңізбен қауіпсіз түрде интеграциялаңыз. REST негізіндегі, тұрақты әрі болжамды API.
UDENTIVA API 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"
Сыртқа ашылатын барлық ұштар төменде. Әр ресурстың мәлімет бетінде параметрлер, үлгі сұраныс/жауап және қауіпсіздік ескертпелері бар. Жазу ұштары Idempotency-Key тақырыпшасын қолдайды.
/v1/patients
Науқастар тізімін беттелген түрде алады
/v1/patients
Жаңа науқас жазбасын жасайды
/v1/patients/{id}
Бір науқастың толығын алады
/v1/patients/{id}
Науқас ақпаратын жаңартады
/v1/patients/{id}
Науқасты мұрағаттайды (soft-delete)
/v1/patients/{id}/medical
Анамнезді, аллергияны және медициналық тарихты тізімдейді
/v1/patients/{id}/medical
Медициналық/анамнез жазбасын қосады
/v1/patients/{id}/documents
Науқас құжаттарын тізімдейді
/v1/patients/{id}/documents
Науқасқа құжат қосады
/v1/appointments
Қабылдауларды күн аралығы бойынша тізімдейді
/v1/appointments
Жаңа қабылдау жасайды (қабаттасу бақыланады)
/v1/appointments/{id}/status
Қабылдау жай-күйін өзгертеді
/v1/appointments/{id}/reschedule
Қабылдауды қайта жоспарлайды
/v1/appointments/{id}/remind
Қабылдау еске салуын жібереді
/v1/units
Кресло/бірліктерді тізімдейді
/v1/doctors
Дәрігерлерді тізімдейді
/v1/waitlist
Күту тізімін алады
/v1/waitlist
Күту тізіміне науқас қосады
/v1/waitlist/{id}
Күту тізімінен шығарады
/v1/patients/{id}/odontogram
Ағымдағы FDI тіс картасын алады
/v1/patients/{id}/odontogram
Тіс жай-күйін қосады (append-only)
/v1/patients/{id}/odontogram/{tooth}/history
Тістің жай-күй тарихын алады
/v1/services
Қызмет/әрекет каталогын тізімдейді
/v1/services
Қызмет бабын қосады
/v1/services/{id}
Қызмет бабын жаңартады
/v1/patients/{id}/plans
Науқастың емдеу жоспарларын тізімдейді
/v1/patients/{id}/plans
Емдеу жоспарын жасайды
/v1/plans/{id}
Емдеу жоспары толығын алады
/v1/plans/{id}/status
Жоспар жай-күйін өзгертеді
/v1/plans/{id}/items
Жоспарға кезең/баб қосады
/v1/plan-items/{id}/status
Жоспар бабының жай-күйін өзгертеді
/v1/patients/{id}/prescriptions
Рецепттерді тізімдейді
/v1/patients/{id}/prescriptions
Рецепт жасайды
/v1/invoices
Шот-фактура жасайды
/v1/invoices
Шот-фактураларды тізімдейді
/v1/invoices/{id}
Шот-фактура толығын алады
/v1/invoices/{id}/void
Шот-фактураны жояды (кері жазба)
/v1/invoices/{id}/einvoice
Шот-фактураны e-Fatura ретінде жібереді (GİB)
/v1/einvoices
e-Fatura жазбаларын тізімдейді
/v1/payments
Инкассо тіркейді (идемпотенттік)
/v1/patients/{id}/balance
Науқастың ағымдағы (cari) балансын алады
/v1/patients/{id}/ledger
Науқастың ағымдағы (cari) қозғалыстарын тізімдейді
/v1/cash/day
Күн соңы касса қорытындысын алады
/v1/cari
Ағымдағы (cari) баланстарды тізімдейді
/v1/billing/summary
Қаржы/инкассо қорытындысын алады
/v1/stock
Қор карталарын тізімдейді
/v1/stock/critical
Сыни деңгейдегі қорларды тізімдейді
/v1/stock
Қор картасын жасайды
/v1/stock/{id}
Қор картасын жаңартады
/v1/stock/{id}/movement
Қор қозғалысын (кіріс/шығыс) қосады
/v1/stock/{id}/movements
Қор қозғалыстарын тізімдейді
/v1/patients/{id}/images
Науқас кескіндерін (рентген/фото) тізімдейді
/v1/patients/{id}/images
Кескін жүктейді (S3, stream/presigned)
/v1/images/{id}/raw
Кескін файлын жүктеп алады (presigned)
/v1/lab-orders
Зертхана тапсырыстарын тізімдейді
/v1/lab-orders
Зертхана тапсырысын жасайды
/v1/lab-orders/{id}
Тапсырыс толығын алады
/v1/lab-orders/{id}
Тапсырысты жаңартады
/v1/lab-orders/{id}/status
Тапсырыс жай-күйін өзгертеді
/v1/labs
Келісімшарттық зертханаларды тізімдейді
/v1/labs
Зертхана қосады
/v1/leads
Lead/өтінімдерді тізімдейді
/v1/leads
Жаңа lead жасайды
/v1/leads/{id}/status
Lead жай-күйін/кезеңін өзгертеді
/v1/tasks
Тапсырмаларды тізімдейді
/v1/tasks
Тапсырма жасайды
/v1/messages
Науқаспен байланыс хабарламаларын тізімдейді
/v1/messages
Хабарлама/байланыс жазбасын жасайды
/v1/tourism-cases
Денсаулық туризмі жағдайларын тізімдейді
/v1/tourism-cases
Туризм жағдайын жасайды
/v1/tourism-cases/{id}/status
Жағдай кезеңін өзгертеді
/v1/shipments
Трансфер/жөнелту жазбаларын тізімдейді
/v1/shipments
Трансфер/жөнелту жазбасын жасайды
/v1/bi
Бизнес аналитикасы метрикаларын алады
/v1/profit
Пайдалылық есебін алады
/v1/rcm
Табыс циклі (RCM) метрикаларын алады
/v1/webhooks
Тіркелген webhook жазылымдарын тізімдейді
/v1/webhooks
Оқиға хабарламасы үшін webhook тіркейді
/v1/webhooks/{id}
Webhook жазылымын жояды
/export/v1
Кілттің рұқсат етілген деректер жиынтығын және пайдалану ақпаратын қайтарады (барлау)
/export/v1/{dataset}
Таңдалған деректер жиынтығын беттелген түрде тартады (?limit=1000&offset=0)
Қателер тұрақты конвертпен қайтарылады; код машинаға, хабар қолданушыға арналған. Ішкі қате/стек ешқашан сызылмайды.
{
"error": {
"code": "validation_failed",
"message": "Жарамсыз өріс: электрондық пошта"
}
}
Сұраныстар минутына шектеледі. Шектен асқанда 429 қайтарылады; жауап тақырыпшаларында қалған квота ақпараты тасымалданады.
API нұсқасы жол ішінде тасымалданады (мыс. /v1). Кері үйлесімділікті бұзатын өзгерістер жаңа нұсқамен шығарылады.
Клиникаңызда оқиғалар орын алған сайын тіркелген мекенжайыңызға қолтаңбаланған хабарлама жіберіледі. Осылайша өз жүйеңізді лезде өзекті ұстайсыз.
# Үлгі оқиға типтері
patient.created appointment.created appointment.status_changed
invoice.created payment.created lab_order.status_changed
treatment_plan.updated lead.created tourism_case.status_changed
We use cookies necessary for core functionality; analytics and marketing cookies are enabled only with your consent. Cookie саясаты