UDENTIVA Ağıllı Dental İdarəetmə Platforması
TƏRTİBATÇILAR

UDENTIVA API Sənədləri

Klinika verinizi öz sistemlərinizlə təhlükəsiz şəkildə inteqrasiya edin. REST əsaslı, ardıcıl və proqnozlaşdırıla bilən bir API.

Xarici API girişi tezliklə açılacaq
Aşağıdakı uçlar kənara açılacaq tam əhatədir. Erkən giriş üçün əlaqə saxlayın.
API Təhlükəsizlik Modeli
Verilən izolyasiyası, idempotent yazma, parametrli sorğu — koda əsaslı təhlükəsizlik. →

Ümumi Baxış

UDENTIVA API, REST prinsiplərinə uyğun gəlir; JSON gövdə istifadə edir və standart HTTP status kodları qaytarır. Bütün sorğular HTTPS üzərindən edilir və API açarı ilə kimlik doğrulanır. Hər sorğu, açarın bağlı olduğu klinikanın verisi ilə məhduddur (tam verilən izolyasiyası).

Əsas ünvan:

https://api.udentiva.com

Kimlik Doğrulama

Sorğularda API açarınızı Authorization başlığında daşıyın. Açarlar klinika paneli üzərindən yaradılır və istədiyiniz zaman ləğv edilə bilər.

# Nümunə sorğu
curl https://api.udentiva.com/v1/patients \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Accept: application/json"

Uçlar

81 uc · 12 mənbə

Kənara açılacaq bütün uc nöqtələr aşağıdadır. Hər mənbənin detal səhifəsində parametrlər, nümunə sorğu/cavab və təhlükəsizlik qeydləri var. Yazma ucları Idempotency-Key başlığını dəstəkləyir.

Xəstələr · 9

Detal və nümunə →
GET /v1/patients Xəstə siyahısını səhifələnmiş gətirir
POST /v1/patients Yeni xəstə qeydi yaradır
GET /v1/patients/{id} Tək xəstənin təfərrüatını gətirir
PUT /v1/patients/{id} Xəstə məlumatlarını yeniləyir
DELETE /v1/patients/{id} Xəstəni arxivləşdirir (soft-delete)
GET /v1/patients/{id}/medical Anamnez, allergiya və tibbi keçmişi siyahılayır
POST /v1/patients/{id}/medical Tibbi/anamnez qeydi əlavə edir
GET /v1/patients/{id}/documents Xəstə sənədlərini siyahılayır
POST /v1/patients/{id}/documents Xəstəyə sənəd əlavə edir

Görüş & Təqvim · 10

Detal və nümunə →
GET /v1/appointments Randevuları tarix aralığına görə siyahılayır
POST /v1/appointments Yeni randevu yaradır (toqquşma nəzarətli)
POST /v1/appointments/{id}/status Randevu vəziyyətini dəyişir
POST /v1/appointments/{id}/reschedule Randevunu yenidən planlaşdırır
POST /v1/appointments/{id}/remind Randevu xatırlatması göndərir
GET /v1/units Koltuq/vahidləri (kreslo/unit) siyahılayır
GET /v1/doctors Həkimləri siyahılayır
GET /v1/waitlist Gözləmə siyahısını gətirir
POST /v1/waitlist Gözləmə siyahısına xəstə əlavə edir
DELETE /v1/waitlist/{id} Gözləmə siyahısından çıxarır

Odontoqram & Müalicə · 14

Detal və nümunə →
GET /v1/patients/{id}/odontogram Cari FDI diş xəritəsini gətirir
POST /v1/patients/{id}/odontogram Diş vəziyyəti əlavə edir (append-only)
GET /v1/patients/{id}/odontogram/{tooth}/history Bir dişin vəziyyət tarixçəsini gətirir
GET /v1/services Xidmət/əməliyyat kataloqunu siyahılayır
POST /v1/services Xidmət maddəsi əlavə edir
PUT /v1/services/{id} Xidmət maddəsini yeniləyir
GET /v1/patients/{id}/plans Xəstənin müalicə planlarını siyahılayır
POST /v1/patients/{id}/plans Müalicə planı yaradır
GET /v1/plans/{id} Müalicə planı təfərrüatını gətirir
POST /v1/plans/{id}/status Plan vəziyyətini dəyişir
POST /v1/plans/{id}/items Plana mərhələ/maddə əlavə edir
POST /v1/plan-items/{id}/status Plan maddəsinin vəziyyətini dəyişir
GET /v1/patients/{id}/prescriptions Reseptləri siyahılayır
POST /v1/patients/{id}/prescriptions Resept yaradır

Tahsilat və Maliyyə · 12

Detal və nümunə →
POST /v1/invoices Faktura yaradır
GET /v1/invoices Fakturaları siyahılayır
GET /v1/invoices/{id} Faktura təfərrüatını gətirir
POST /v1/invoices/{id}/void Fakturanı ləğv edir (əks qeyd)
POST /v1/invoices/{id}/einvoice Fakturanı e-Fatura olaraq göndərir (GİB)
GET /v1/einvoices e-Fatura qeydlərini siyahılayır
POST /v1/payments Ödəniş qəbulu qeyd edir (idempotent)
GET /v1/patients/{id}/balance Xəstə cari balansını gətirir
GET /v1/patients/{id}/ledger Xəstə cari hərəkətlərini siyahılayır
GET /v1/cash/day Gün sonu kassa xülasəsini gətirir
GET /v1/cari Cari balansları siyahılayır
GET /v1/billing/summary Maliyyə/ödəniş qəbulu xülasəsini gətirir

Anbar · 6

Detal və nümunə →
GET /v1/stock Stok kartlarını siyahılayır
GET /v1/stock/critical Kritik səviyyədəki stokları siyahılayır
POST /v1/stock Stok kartı yaradır
PUT /v1/stock/{id} Stok kartını yeniləyir
POST /v1/stock/{id}/movement Stok hərəkəti (giriş/çıxış) əlavə edir
GET /v1/stock/{id}/movements Stok hərəkətlərini siyahılayır

Görüntüləmə · 3

Detal və nümunə →
GET /v1/patients/{id}/images Xəstə görüntülərini (rentgen/foto) siyahılayır
POST /v1/patients/{id}/images Görüntü yükləyir (S3, stream/presigned)
GET /v1/images/{id}/raw Görüntü faylını yükləyir (presigned)

Laboratoriya · 7

Detal və nümunə →
GET /v1/lab-orders Lab sifarişlərini siyahılayır
POST /v1/lab-orders Lab sifarişi yaradır
GET /v1/lab-orders/{id} Sifariş təfərrüatını gətirir
PUT /v1/lab-orders/{id} Sifarişi yeniləyir
POST /v1/lab-orders/{id}/status Sifariş vəziyyətini dəyişir
GET /v1/labs Müqaviləli laboratoriyaları siyahılayır
POST /v1/labs Laboratoriya əlavə edir

Lead & CRM · 7

Detal və nümunə →
GET /v1/leads Lead/müraciətləri siyahılayır
POST /v1/leads Yeni lead yaradır
POST /v1/leads/{id}/status Lead vəziyyətini/mərhələsini dəyişir
GET /v1/tasks Tapşırıqları siyahılayır
POST /v1/tasks Tapşırıq yaradır
GET /v1/messages Xəstə ünsiyyət mesajlarını siyahılayır
POST /v1/messages Mesaj/ünsiyyət qeydi yaradır

Sağlamlıq Turizmi · 5

Detal və nümunə →
GET /v1/tourism-cases Sağlıq turizmi hallarını siyahılayır
POST /v1/tourism-cases Turizm halı yaradır
POST /v1/tourism-cases/{id}/status Hal mərhələsini dəyişir
GET /v1/shipments Transfer/göndərmə qeydlərini siyahılayır
POST /v1/shipments Transfer/göndərmə qeydi yaradır

Hesabatlama & BI · 3

Detal və nümunə →
GET /v1/bi Biznes zəkası (BI) metrikalarını gətirir
GET /v1/profit Gəlirlilik hesabatını gətirir
GET /v1/rcm Gəlir dövrü (RCM) metrikalarını gətirir

Webhooks · 3

Detal və nümunə →
GET /v1/webhooks Qeydli webhook abunəliklərini siyahılayır
POST /v1/webhooks Hadisə bildirişi üçün webhook qeyd edir
DELETE /v1/webhooks/{id} Webhook abunəliyini silir

Veri Ötürülməsi (Export API) · 2

Detal və nümunə →
GET /export/v1 Açarın icazə verilmiş verilənlər toplularını və istifadə məlumatını qaytarır (kəşf)
GET /export/v1/{dataset} Seçili verilənlər toplusunu səhifələnmiş çəkir (?limit=1000&offset=0)

Xəta Formatı

Xətalar ardıcıl bir zərf ilə qayıdır; kod maşına, mesaj istifadəçiyə yönəlikdir. Daxili xəta/stack heç vaxt sızdırılmır.

{
  "error": {
    "code": "validation_failed",
    "message": "Yanlış sahə: e-poçt"
  }
}

Sürət Limiti

Sorğular dəqiqə başına məhdudlaşdırılır. Limit aşıldıqda 429 qayıdır; cavab başlıqlarında qalan kvota məlumatı daşınır.

Versiyalama

API versiyası yol üzərində daşınır (məs. /v1). Geriyə uyğunluğu pozan dəyişikliklər yeni bir versiya ilə buraxılır.

Webhook Hadisələri

Klinikanızda hadisələr baş verdikcə qeydli ünvanınıza imzalı bir bildiriş göndərilir. Beləliklə öz sisteminizi anlıq aktual saxlayırsınız.

# Nümunə hadisə tipləri
patient.created   appointment.created   appointment.status_changed
invoice.created   payment.created       lab_order.status_changed
treatment_plan.updated   lead.created   tourism_case.status_changed
Erkən giriş istəyirsiniz?
API açıldıqda ilk siz xəbərdar olun.
Əlaqə Saxla