UDENTIVA แพลตฟอร์มการจัดการทันตกรรมอัจฉริยะ

เริ่มต้นฟรี

นักพัฒนา

เอกสาร API ของ UDENTIVA

เชื่อมข้อมูลคลินิกของคุณเข้ากับระบบของคุณเองอย่างปลอดภัย เป็น API แบบ REST ที่สอดคล้องและคาดการณ์ได้

การเข้าถึง API ภายนอกจะเปิดในเร็ว ๆ นี้

เอนด์พอยต์ด้านล่างคือขอบเขตทั้งหมดที่จะเปิดให้เข้าถึง ติดต่อเราเพื่อรับสิทธิ์เข้าถึงก่อนใคร

โมเดลความปลอดภัยของ API

การแยกข้อมูล การเขียนแบบ idempotent คำสั่งแบบมีพารามิเตอร์ — ความปลอดภัยที่อยู่บนพื้นฐานของโค้ด →

ภาพรวม

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} นำผู้ป่วยออกจากรายการรอ

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": "ฟิลด์ไม่ถูกต้อง: อีเมล"
  }
}

ขีดจำกัดอัตรา (Rate Limit)

คำขอถูกจำกัดต่อนาที เมื่อเกินขีดจำกัด จะคืน 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 เปิดให้ใช้งาน

ติดต่อเรา