API РЕСУРСЫ

Webhooks

Клиникаңызда оқиғалар орын алған сайын тіркелген мекенжайыңызға қол қойылған хабарлама жіберіледі; өз жүйеңізді нақты уақытта өзекті ұстайсыз.

Ерте Қатынау Барлық API

Ұштар

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-дан келгенін растайсыз.

Қайта жіберу қауіпсіз: әрбір оқиғаның бірегей идентификаторы бар; қосарланған жеткізуді идентификатордан сүзе аласыз (идемпотенттік тұтыну).

Webhook жазылымдары клиникаңызға оқшауланған; тек өз оқиғаларыңызды аласыз.

Бүкіл қауіпсіздік моделі →

Қате Форматы

Қателер тұрақты конвертпен қайтарылады; код машинаға, хабар қолданушыға арналған. Ішкі қате/стек ешқашан сызылмайды.

{
  "error": {
    "code": "validation_failed",
    "message": "Жарамсыз өріс: электрондық пошта"
  }
}

Басқа Ресурстар

Науқастар Қабылдау & Күнтізбе Одонтограмма & Емдеу Төлем және Қаржы Қор Бейнелеу Зертхана Lead & CRM Медициналық туризм Есеп беру & BI Деректерді Тасымалдау (Export API)

Ерте қатынау қалайсыз ба?

API ашылғанда алдымен сіз хабардар болыңыз.

Байланысу