Tích hợp dữ liệu phòng khám của bạn với hệ thống riêng một cách an toàn. Một API dựa trên REST, nhất quán và có thể dự đoán.
API của UDENTIVA tuân theo các nguyên tắc REST; dùng thân JSON và trả về các mã trạng thái HTTP tiêu chuẩn. Mọi yêu cầu đều được thực hiện qua HTTPS và được xác thực bằng khóa API. Mỗi yêu cầu bị giới hạn trong dữ liệu của phòng khám mà khóa gắn với (cô lập dữ liệu hoàn toàn).
Địa chỉ cơ sở:
https://api.udentiva.com
Trong các yêu cầu, hãy mang khóa API của bạn trong tiêu đề Authorization. Các khóa được tạo qua bảng điều khiển phòng khám và có thể bị hủy bất cứ lúc nào.
# Yêu cầu ví dụ curl https://api.udentiva.com/v1/patients \ -H "Authorization: Bearer udk_live_xxx" \ -H "Accept: application/json"
Tất cả các endpoint sẽ được mở ra bên ngoài đều nằm bên dưới. Trang chi tiết của mỗi tài nguyên có tham số, ví dụ yêu cầu/phản hồi và ghi chú bảo mật. Các endpoint ghi hỗ trợ tiêu đề Idempotency-Key.
/v1/patients
Lấy danh sách bệnh nhân theo trang
/v1/patients
Tạo hồ sơ bệnh nhân mới
/v1/patients/{id}
Lấy chi tiết của một bệnh nhân
/v1/patients/{id}
Cập nhật thông tin bệnh nhân
/v1/patients/{id}
Lưu trữ bệnh nhân (soft-delete)
/v1/patients/{id}/medical
Liệt kê bệnh sử, dị ứng và tiền sử y tế
/v1/patients/{id}/medical
Thêm bản ghi y tế/bệnh sử
/v1/patients/{id}/documents
Liệt kê tài liệu của bệnh nhân
/v1/patients/{id}/documents
Thêm tài liệu cho bệnh nhân
/v1/appointments
Liệt kê cuộc hẹn theo khoảng thời gian
/v1/appointments
Tạo cuộc hẹn mới (có kiểm tra xung đột)
/v1/appointments/{id}/status
Thay đổi trạng thái cuộc hẹn
/v1/appointments/{id}/reschedule
Lên lịch lại cuộc hẹn
/v1/appointments/{id}/remind
Gửi nhắc nhở cuộc hẹn
/v1/units
Liệt kê ghế/đơn vị điều trị
/v1/doctors
Liệt kê các bác sĩ
/v1/waitlist
Lấy danh sách chờ
/v1/waitlist
Thêm bệnh nhân vào danh sách chờ
/v1/waitlist/{id}
Xóa khỏi danh sách chờ
/v1/patients/{id}/odontogram
Lấy bản đồ răng FDI hiện tại
/v1/patients/{id}/odontogram
Thêm trạng thái răng (append-only)
/v1/patients/{id}/odontogram/{tooth}/history
Lấy lịch sử trạng thái của một chiếc răng
/v1/services
Liệt kê danh mục dịch vụ/thủ thuật
/v1/services
Thêm hạng mục dịch vụ
/v1/services/{id}
Cập nhật hạng mục dịch vụ
/v1/patients/{id}/plans
Liệt kê các kế hoạch điều trị của bệnh nhân
/v1/patients/{id}/plans
Tạo kế hoạch điều trị
/v1/plans/{id}
Lấy chi tiết kế hoạch điều trị
/v1/plans/{id}/status
Thay đổi trạng thái kế hoạch
/v1/plans/{id}/items
Thêm giai đoạn/hạng mục vào kế hoạch
/v1/plan-items/{id}/status
Thay đổi trạng thái hạng mục kế hoạch
/v1/patients/{id}/prescriptions
Liệt kê các đơn thuốc
/v1/patients/{id}/prescriptions
Tạo đơn thuốc
/v1/invoices
Tạo hóa đơn
/v1/invoices
Liệt kê các hóa đơn
/v1/invoices/{id}
Lấy chi tiết hóa đơn
/v1/invoices/{id}/void
Hủy hóa đơn (bút toán đảo)
/v1/invoices/{id}/einvoice
Gửi hóa đơn dưới dạng e-Fatura (GİB)
/v1/einvoices
Liệt kê các bản ghi e-Fatura
/v1/payments
Ghi nhận thu tiền (idempotent)
/v1/patients/{id}/balance
Lấy số dư công nợ của bệnh nhân
/v1/patients/{id}/ledger
Liệt kê các giao dịch công nợ của bệnh nhân
/v1/cash/day
Lấy tóm tắt quỹ cuối ngày
/v1/cari
Liệt kê số dư công nợ
/v1/billing/summary
Lấy tóm tắt tài chính/thu tiền
/v1/stock
Liệt kê các thẻ tồn kho
/v1/stock/critical
Liệt kê các mặt hàng tồn kho ở mức tới hạn
/v1/stock
Tạo thẻ tồn kho
/v1/stock/{id}
Cập nhật thẻ tồn kho
/v1/stock/{id}/movement
Thêm giao dịch tồn kho (nhập/xuất)
/v1/stock/{id}/movements
Liệt kê các giao dịch tồn kho
/v1/patients/{id}/images
Liệt kê hình ảnh (X-quang/ảnh) của bệnh nhân
/v1/patients/{id}/images
Tải lên hình ảnh (S3, stream/presigned)
/v1/images/{id}/raw
Tải xuống tệp hình ảnh (presigned)
/v1/lab-orders
Liệt kê các đơn hàng lab
/v1/lab-orders
Tạo đơn hàng lab
/v1/lab-orders/{id}
Lấy chi tiết đơn hàng
/v1/lab-orders/{id}
Cập nhật đơn hàng
/v1/lab-orders/{id}/status
Thay đổi trạng thái đơn hàng
/v1/labs
Liệt kê các phòng lab có hợp đồng
/v1/labs
Thêm phòng lab
/v1/leads
Liệt kê lead/yêu cầu
/v1/leads
Tạo lead mới
/v1/leads/{id}/status
Thay đổi trạng thái/giai đoạn của lead
/v1/tasks
Liệt kê các công việc
/v1/tasks
Tạo công việc
/v1/messages
Liệt kê tin nhắn giao tiếp của bệnh nhân
/v1/messages
Tạo bản ghi tin nhắn/giao tiếp
/v1/tourism-cases
Liệt kê các ca du lịch y tế
/v1/tourism-cases
Tạo ca du lịch
/v1/tourism-cases/{id}/status
Thay đổi giai đoạn của ca
/v1/shipments
Liệt kê các bản ghi chuyển/vận chuyển
/v1/shipments
Tạo bản ghi chuyển/vận chuyển
/v1/bi
Lấy các chỉ số trí tuệ kinh doanh
/v1/profit
Lấy báo cáo lợi nhuận
/v1/rcm
Lấy các chỉ số vòng đời doanh thu (RCM)
/v1/webhooks
Liệt kê các đăng ký webhook đã lưu
/v1/webhooks
Đăng ký webhook cho thông báo sự kiện
/v1/webhooks/{id}
Xóa đăng ký webhook
/export/v1
Trả về các tập dữ liệu được phép và thông tin sử dụng của khóa (khám phá)
/export/v1/{dataset}
Trích xuất tập dữ liệu đã chọn theo trang (?limit=1000&offset=0)
Lỗi trả về trong một phong bì nhất quán; mã hướng đến máy, thông điệp hướng đến người dùng. Lỗi nội bộ/stack không bao giờ bị rò rỉ.
{
"error": {
"code": "validation_failed",
"message": "Trường không hợp lệ: email"
}
}
Các yêu cầu bị giới hạn theo mỗi phút. Khi vượt giới hạn, hệ thống trả về 429; các tiêu đề phản hồi mang thông tin hạn ngạch còn lại.
Phiên bản API được mang trong đường dẫn (ví dụ /v1). Những thay đổi phá vỡ tương thích ngược sẽ được phát hành ở một phiên bản mới.
Khi các sự kiện diễn ra ở phòng khám, một thông báo có chữ ký được gửi đến địa chỉ đã đăng ký của bạn. Nhờ đó, bạn giữ cho hệ thống của chính mình luôn cập nhật tức thời.
# Các loại sự kiện ví dụ
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. Chính sách Cookie