ابدأ مجانًا

للمطوّرين

توثيق UDENTIVA API

ادمج بيانات عيادتك بأمان مع أنظمتك الخاصة. API قائم على 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"

النقاط الطرفية

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} يزيل من قائمة الانتظار

المخطط السنّي (Odontogram) والعلاج · 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 يسجّل تحصيلًا (idempotent)

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)

صيغة الأخطاء

تُعاد الأخطاء بغلاف متسق؛ الرمز موجَّه للآلة والرسالة للمستخدم. لا يُسرَّب الخطأ الداخلي/التتبّع (stack) أبدًا.

{
  "error": {
    "code": "validation_failed",
    "message": "حقل غير صالح: البريد الإلكتروني"
  }
}

حدّ المعدّل

تُحدَّد الطلبات بحدّ في الدقيقة. عند تجاوز الحدّ يُعاد 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.

تواصل معنا