مورد API

Webhooks

مع وقوع الأحداث في عيادتك يُرسَل إشعار موقّع إلى عنوانك المسجّل؛ فتُبقي نظامك الخاص محدّثًا آنيًا.

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

3 نقطة طرفية

النقاط الطرفية العائدة لهذا المورد. تقتصر كل نقطة على بيانات العيادة المرتبطة بمفتاح API؛ وتدعم نقاط الكتابة ترويسة Idempotency-Key.

GET /v1/webhooks يعرض قائمة اشتراكات الـ webhook المسجّلة admin

POST /v1/webhooks يسجّل webhook لإشعار الأحداث admin

DELETE /v1/webhooks/{id} يحذف اشتراك الـ webhook admin

مثال استخدام

سجّل webhook

الطلب

curl -X POST https://api.udentiva.com/v1/webhooks \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://siz.example/hook","events":["payment.created"]}'

الاستجابة

HTTP/1.1 201 Created
{
  "id": "wh-1",
  "url": "https://siz.example/hook",
  "events": ["payment.created"],
  "secret": "whsec_xxx"
}

الأمان في هذا المورد

الأمان ليس ميزة، بل المعمارية نفسها. الضمانات السارية في هذا المورد:

يُوقَّع كل إشعار بمفتاح سري مشترك (HMAC)؛ وبالتحقق من التوقيع تتأكد أن الطلب صادر فعلًا من UDENTIVA.

إعادة الإرسال آمنة: لكل حدث معرّف فريد؛ ويمكنك تصفية التسليم المكرر بالاعتماد على المعرّف (استهلاك idempotent).

اشتراكات الـ webhook معزولة لعيادتك؛ ولا تستقبل سوى أحداثك أنت.

نموذج الأمان الكامل →

صيغة الأخطاء

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

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

موارد أخرى

المرضى المواعيد والتقويم المخطط السنّي (Odontogram) والعلاج التحصيل والمالية المخزون التصوير المختبر Lead وCRM السياحة الصحية التقارير وذكاء الأعمال (BI) نقل البيانات (Export API)

هل ترغب في الوصول المبكر؟

كن أول من يعلم عند إتاحة API.

تواصل معنا