UDENTIVA Platform Pengurusan Pergigian Pintar

Mula Percuma

PEMBANGUN

Dokumentasi API UDENTIVA

Integrasikan data klinik anda dengan sistem anda sendiri secara selamat. API berasaskan REST yang tekal dan boleh diramal.

Akses API luaran akan dibuka tidak lama lagi

Titik akhir di bawah ialah skop penuh yang akan dibuka kepada umum. Hubungi kami untuk akses awal.

Model Keselamatan API

Pengasingan data, penulisan idempoten, pertanyaan berparameter — keselamatan berlandaskan kod. →

Gambaran Keseluruhan

API UDENTIVA mematuhi prinsip REST; ia menggunakan badan JSON dan memulangkan kod status HTTP standard. Semua permintaan dibuat melalui HTTPS dan disahkan dengan kunci API. Setiap permintaan terhad kepada data klinik yang dikaitkan dengan kunci (pengasingan data penuh).

Alamat asas:

https://api.udentiva.com

Pengesahan Identiti

Bawa kunci API anda dalam pengepala Authorization pada permintaan. Kunci dijana melalui panel klinik dan boleh dibatalkan pada bila-bila masa.

# Contoh permintaan
curl https://api.udentiva.com/v1/patients \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Accept: application/json"

Titik Akhir

81 titik akhir · 12 sumber

Semua titik akhir yang akan dibuka kepada umum tertera di bawah. Pada halaman butiran setiap sumber terdapat parameter, contoh permintaan/respons dan nota keselamatan. Titik akhir penulisan menyokong pengepala Idempotency-Key.

Pesakit · 9

Butiran & contoh →

GET /v1/patients Mendapatkan senarai pesakit secara berhalaman

POST /v1/patients Mencipta rekod pesakit baharu

GET /v1/patients/{id} Mendapatkan butiran seorang pesakit

PUT /v1/patients/{id} Mengemas kini maklumat pesakit

DELETE /v1/patients/{id} Mengarkibkan pesakit (soft-delete)

GET /v1/patients/{id}/medical Menyenaraikan anamnesis, alahan dan sejarah perubatan

POST /v1/patients/{id}/medical Menambah rekod perubatan/anamnesis

GET /v1/patients/{id}/documents Menyenaraikan dokumen pesakit

POST /v1/patients/{id}/documents Menambah dokumen kepada pesakit

Penjadualan & Kalendar · 10

Butiran & contoh →

GET /v1/appointments Menyenaraikan temu janji mengikut julat tarikh

POST /v1/appointments Mencipta temu janji baharu (dengan kawalan pertindihan)

POST /v1/appointments/{id}/status Menukar status temu janji

POST /v1/appointments/{id}/reschedule Menjadualkan semula temu janji

POST /v1/appointments/{id}/remind Menghantar peringatan temu janji

GET /v1/units Menyenaraikan kerusi/unit

GET /v1/doctors Menyenaraikan doktor

GET /v1/waitlist Mendapatkan senarai menunggu

POST /v1/waitlist Menambah pesakit ke senarai menunggu

DELETE /v1/waitlist/{id} Mengeluarkan daripada senarai menunggu

Odontogram & Rawatan · 14

Butiran & contoh →

GET /v1/patients/{id}/odontogram Mendapatkan peta gigi FDI semasa

POST /v1/patients/{id}/odontogram Menambah status gigi (append-only)

GET /v1/patients/{id}/odontogram/{tooth}/history Mendapatkan sejarah status sesuatu gigi

GET /v1/services Menyenaraikan katalog perkhidmatan/prosedur

POST /v1/services Menambah item perkhidmatan

PUT /v1/services/{id} Mengemas kini item perkhidmatan

GET /v1/patients/{id}/plans Menyenaraikan pelan rawatan pesakit

POST /v1/patients/{id}/plans Mencipta pelan rawatan

GET /v1/plans/{id} Mendapatkan butiran pelan rawatan

POST /v1/plans/{id}/status Menukar status pelan

POST /v1/plans/{id}/items Menambah peringkat/item kepada pelan

POST /v1/plan-items/{id}/status Menukar status item pelan

GET /v1/patients/{id}/prescriptions Menyenaraikan preskripsi

POST /v1/patients/{id}/prescriptions Mencipta preskripsi

Kutipan & Kewangan · 12

Butiran & contoh →

POST /v1/invoices Mencipta invois

GET /v1/invoices Menyenaraikan invois

GET /v1/invoices/{id} Mendapatkan butiran invois

POST /v1/invoices/{id}/void Membatalkan invois (rekod balikan)

POST /v1/invoices/{id}/einvoice Menghantar invois sebagai e-Fatura (GİB)

GET /v1/einvoices Menyenaraikan rekod e-Fatura

POST /v1/payments Merekod tahsilat (idempoten)

GET /v1/patients/{id}/balance Mendapatkan baki akaun semasa pesakit

GET /v1/patients/{id}/ledger Menyenaraikan pergerakan akaun semasa pesakit

GET /v1/cash/day Mendapatkan ringkasan kunci wang hujung hari

GET /v1/cari Menyenaraikan baki akaun semasa

GET /v1/billing/summary Mendapatkan ringkasan kewangan/tahsilat

Stok · 6

Butiran & contoh →

GET /v1/stock Menyenaraikan kad stok

GET /v1/stock/critical Menyenaraikan stok pada aras kritikal

POST /v1/stock Mencipta kad stok

PUT /v1/stock/{id} Mengemas kini kad stok

POST /v1/stock/{id}/movement Menambah pergerakan stok (masuk/keluar)

GET /v1/stock/{id}/movements Menyenaraikan pergerakan stok

Pengimejan · 3

Butiran & contoh →

GET /v1/patients/{id}/images Menyenaraikan imej pesakit (X-ray/foto)

POST /v1/patients/{id}/images Memuat naik imej (S3, stream/presigned)

GET /v1/images/{id}/raw Memuat turun fail imej (presigned)

Makmal · 7

Butiran & contoh →

GET /v1/lab-orders Menyenaraikan pesanan makmal

POST /v1/lab-orders Mencipta pesanan makmal

GET /v1/lab-orders/{id} Mendapatkan butiran pesanan

PUT /v1/lab-orders/{id} Mengemas kini pesanan

POST /v1/lab-orders/{id}/status Menukar status pesanan

GET /v1/labs Menyenaraikan makmal yang berkontrak

POST /v1/labs Menambah makmal

Lead & CRM · 7

Butiran & contoh →

GET /v1/leads Menyenaraikan lead/permintaan

POST /v1/leads Mencipta lead baharu

POST /v1/leads/{id}/status Menukar status/peringkat lead

GET /v1/tasks Menyenaraikan tugas

POST /v1/tasks Mencipta tugas

GET /v1/messages Menyenaraikan mesej komunikasi pesakit

POST /v1/messages Mencipta rekod mesej/komunikasi

Pelancongan Kesihatan · 5

Butiran & contoh →

GET /v1/tourism-cases Menyenaraikan kes pelancongan kesihatan

POST /v1/tourism-cases Mencipta kes pelancongan

POST /v1/tourism-cases/{id}/status Menukar peringkat kes

GET /v1/shipments Menyenaraikan rekod pemindahan/penghantaran

POST /v1/shipments Mencipta rekod pemindahan/penghantaran

Pelaporan & BI · 3

Butiran & contoh →

GET /v1/bi Mendapatkan metrik kecerdasan perniagaan

GET /v1/profit Mendapatkan laporan keuntungan

GET /v1/rcm Mendapatkan metrik kitaran hasil (RCM)

Webhooks · 3

Butiran & contoh →

GET /v1/webhooks Menyenaraikan langganan webhook yang berdaftar

POST /v1/webhooks Mendaftarkan webhook untuk pemberitahuan peristiwa

DELETE /v1/webhooks/{id} Memadam langganan webhook

Pemindahan Data (Export API) · 2

Butiran & contoh →

GET /export/v1 Mengembalikan set data yang dibenarkan bagi kunci dan maklumat penggunaan (penemuan)

GET /export/v1/{dataset} Menarik set data terpilih secara berhalaman (?limit=1000&offset=0)

Format Ralat

Ralat dipulangkan dengan sampul yang tekal; kod ditujukan kepada mesin, mesej kepada pengguna. Ralat dalaman/stack tidak sekali-kali dibocorkan.

{
  "error": {
    "code": "validation_failed",
    "message": "Medan tidak sah: e-mel"
  }
}

Had Kadar

Permintaan dihadkan setiap minit. Apabila had melebihi, 429 dipulangkan; maklumat baki kuota dibawa dalam pengepala respons.

Pemberian Versi

Versi API dibawa pada laluan (cth. /v1). Perubahan yang memutuskan keserasian ke belakang akan diterbitkan dengan versi baharu.

Peristiwa Webhook

Apabila peristiwa berlaku di klinik anda, satu pemberitahuan bertandatangan dihantar ke alamat berdaftar anda. Dengan itu, anda mengekalkan sistem anda sendiri sentiasa terkini secara serta-merta.

# Jenis peristiwa contoh
patient.created   appointment.created   appointment.status_changed
invoice.created   payment.created       lab_order.status_changed
treatment_plan.updated   lead.created   tourism_case.status_changed

Mahukan akses awal?

Jadilah orang pertama yang tahu apabila API dibuka.

Hubungi kami