UDENTIVA Smart Dental Management Platform

Magsimula nang Libre

MGA DEVELOPER

Dokumentasyon ng UDENTIVA API

Ligtas na iugnay ang inyong datos ng klinika sa inyong sariling sistema. Isang REST-based, tugma, at nahuhulaang API.

Malapit nang buksan ang panlabas na access sa API

Ang mga endpoint sa ibaba ang buong saklaw na ilalabas sa labas. Makipag-ugnayan para sa maagang access.

Modelo ng Seguridad ng API

Data isolation, idempotent na pagsusulat, parameterized query — seguridad na nakabatay sa code. →

Pangkalahatang-tanaw

Ang UDENTIVA API ay sumusunod sa mga prinsipyo ng REST; gumagamit ito ng JSON body at nagbabalik ng standard na HTTP status code. Ang lahat ng request ay ginagawa sa HTTPS at pinapatunayan gamit ang API key. Ang bawat request ay limitado sa datos ng klinikang naka-ugnay sa key (kumpletong data isolation).

Batayang address:

https://api.udentiva.com

Pagpapatunay ng Pagkakakilanlan

Sa mga request, dalhin ang inyong API key sa Authorization header. Ang mga key ay nabubuo sa pamamagitan ng clinic panel at maaaring kanselahin anumang oras.

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

Mga Endpoint

81 endpoint · 12 mapagkukunan

Nasa ibaba ang lahat ng endpoint na ilalabas sa labas. Sa detail page ng bawat mapagkukunan ay makikita ang mga parameter, halimbawang request/response, at mga tala sa seguridad. Ang mga write endpoint ay sumusuporta sa Idempotency-Key header.

Mga Pasyente · 9

Detalye at halimbawa →

GET /v1/patients Kinukuha ang listahan ng pasyente nang may pahina

POST /v1/patients Gumagawa ng bagong tala ng pasyente

GET /v1/patients/{id} Kinukuha ang detalye ng isang pasyente

PUT /v1/patients/{id} Ina-update ang impormasyon ng pasyente

DELETE /v1/patients/{id} Ina-arkibo ang pasyente (soft-delete)

GET /v1/patients/{id}/medical Inililista ang anamnesis, allergy at medikal na kasaysayan

POST /v1/patients/{id}/medical Nagdaragdag ng medikal/anamnesis na tala

GET /v1/patients/{id}/documents Inililista ang mga dokumento ng pasyente

POST /v1/patients/{id}/documents Nagdaragdag ng dokumento sa pasyente

Pag-iiskedyul & Kalendaryo · 10

Detalye at halimbawa →

GET /v1/appointments Inililista ang mga appointment ayon sa saklaw ng petsa

POST /v1/appointments Gumagawa ng bagong appointment (may kontrol sa banggaan)

POST /v1/appointments/{id}/status Binabago ang katayuan ng appointment

POST /v1/appointments/{id}/reschedule Muling ini-iskedyul ang appointment

POST /v1/appointments/{id}/remind Nagpapadala ng paalala ng appointment

GET /v1/units Inililista ang mga silya/unit

GET /v1/doctors Inililista ang mga doktor

GET /v1/waitlist Kinukuha ang waiting list

POST /v1/waitlist Nagdaragdag ng pasyente sa waiting list

DELETE /v1/waitlist/{id} Inaalis mula sa waiting list

Odontogram & Paggamot · 14

Detalye at halimbawa →

GET /v1/patients/{id}/odontogram Kinukuha ang kasalukuyang FDI dental chart

POST /v1/patients/{id}/odontogram Nagdaragdag ng estado ng ngipin (append-only)

GET /v1/patients/{id}/odontogram/{tooth}/history Kinukuha ang kasaysayan ng estado ng isang ngipin

GET /v1/services Inililista ang katalogo ng serbisyo/prosedyur

POST /v1/services Nagdaragdag ng service item

PUT /v1/services/{id} Ina-update ang service item

GET /v1/patients/{id}/plans Inililista ang mga treatment plan ng pasyente

POST /v1/patients/{id}/plans Gumagawa ng treatment plan

GET /v1/plans/{id} Kinukuha ang detalye ng treatment plan

POST /v1/plans/{id}/status Binabago ang katayuan ng plano

POST /v1/plans/{id}/items Nagdaragdag ng yugto/item sa plano

POST /v1/plan-items/{id}/status Binabago ang katayuan ng plan item

GET /v1/patients/{id}/prescriptions Inililista ang mga reseta

POST /v1/patients/{id}/prescriptions Gumagawa ng reseta

Koleksyon at Pananalapi · 12

Detalye at halimbawa →

POST /v1/invoices Gumagawa ng invoice

GET /v1/invoices Inililista ang mga invoice

GET /v1/invoices/{id} Kinukuha ang detalye ng invoice

POST /v1/invoices/{id}/void Kinakansela ang invoice (reverse entry)

POST /v1/invoices/{id}/einvoice Ipinapadala ang invoice bilang e-Fatura (GİB)

GET /v1/einvoices Inililista ang mga tala ng e-Fatura

POST /v1/payments Nagtatala ng koleksyon (idempotent)

GET /v1/patients/{id}/balance Kinukuha ang balanse ng account ng pasyente

GET /v1/patients/{id}/ledger Inililista ang mga galaw ng account ng pasyente

GET /v1/cash/day Kinukuha ang buod ng end-of-day na kaha

GET /v1/cari Inililista ang mga balanse ng account

GET /v1/billing/summary Kinukuha ang buod ng pananalapi/koleksyon

Stock · 6

Detalye at halimbawa →

GET /v1/stock Inililista ang mga stock card

GET /v1/stock/critical Inililista ang mga stock na nasa kritikal na antas

POST /v1/stock Gumagawa ng stock card

PUT /v1/stock/{id} Ina-update ang stock card

POST /v1/stock/{id}/movement Nagdaragdag ng galaw ng stock (papasok/palabas)

GET /v1/stock/{id}/movements Inililista ang mga galaw ng stock

Imaging · 3

Detalye at halimbawa →

GET /v1/patients/{id}/images Inililista ang mga image (x-ray/photo) ng pasyente

POST /v1/patients/{id}/images Nag-a-upload ng image (S3, stream/presigned)

GET /v1/images/{id}/raw Dina-download ang image file (presigned)

Laboratoryo · 7

Detalye at halimbawa →

GET /v1/lab-orders Inililista ang mga lab order

POST /v1/lab-orders Gumagawa ng lab order

GET /v1/lab-orders/{id} Kinukuha ang detalye ng order

PUT /v1/lab-orders/{id} Ina-update ang order

POST /v1/lab-orders/{id}/status Binabago ang katayuan ng order

GET /v1/labs Inililista ang mga kontratadong laboratoryo

POST /v1/labs Nagdaragdag ng laboratoryo

Lead & CRM · 7

Detalye at halimbawa →

GET /v1/leads Inililista ang mga lead/kahilingan

POST /v1/leads Gumagawa ng bagong lead

POST /v1/leads/{id}/status Binabago ang katayuan/yugto ng lead

GET /v1/tasks Inililista ang mga gawain

POST /v1/tasks Gumagawa ng gawain

GET /v1/messages Inililista ang mga mensahe ng komunikasyon sa pasyente

POST /v1/messages Gumagawa ng tala ng mensahe/komunikasyon

Health Tourism · 5

Detalye at halimbawa →

GET /v1/tourism-cases Inililista ang mga kaso ng health tourism

POST /v1/tourism-cases Gumagawa ng kaso ng turismo

POST /v1/tourism-cases/{id}/status Binabago ang yugto ng kaso

GET /v1/shipments Inililista ang mga tala ng transfer/shipment

POST /v1/shipments Gumagawa ng tala ng transfer/shipment

Pag-uulat & BI · 3

Detalye at halimbawa →

GET /v1/bi Kinukuha ang mga sukatan ng business intelligence

GET /v1/profit Kinukuha ang ulat ng kita

GET /v1/rcm Kinukuha ang mga sukatan ng revenue cycle (RCM)

Webhooks · 3

Detalye at halimbawa →

GET /v1/webhooks Inililista ang mga naka-rehistrong webhook subscription

POST /v1/webhooks Nagrerehistro ng webhook para sa notification ng event

DELETE /v1/webhooks/{id} Binubura ang webhook subscription

Paglipat ng Datos (Export API) · 2

Detalye at halimbawa →

GET /export/v1 Ibinabalik ang mga pinahihintulutang dataset at impormasyon ng paggamit ng key (discovery)

GET /export/v1/{dataset} Kinukuha ang napiling dataset nang may pahina (?limit=1000&offset=0)

Format ng Error

Ang mga error ay ibinabalik sa isang tugmang envelope; ang code ay para sa makina, ang mensahe ay para sa user. Ang panloob na error/stack ay hindi kailanman tumatagas.

{
  "error": {
    "code": "validation_failed",
    "message": "Di-wastong field: email"
  }
}

Rate Limit

Ang mga request ay nililimitahan bawat minuto. Kapag lumampas sa limitasyon, nagbabalik ng 429; ang natitirang quota ay dala sa response header.

Versioning

Ang bersyon ng API ay dala sa path (hal. /v1). Ang mga pagbabagong sumisira sa backward compatibility ay inilalabas sa isang bagong bersyon.

Mga Webhook Event

Habang nangyayari ang mga kaganapan sa inyong klinika, isang naka-sign na notification ang ipinapadala sa inyong nakatalang address. Sa gayon, napananatili ninyong napapanahon ang inyong sariling sistema sa sandaling iyon.

# Mga halimbawang uri ng event
patient.created   appointment.created   appointment.status_changed
invoice.created   payment.created       lab_order.status_changed
treatment_plan.updated   lead.created   tourism_case.status_changed

Gusto ninyo ba ng maagang access?

Maging una kayong makaalam kapag bukas na ang API.

Makipag-ugnayan