Асуумжийн API

Асуумжийн нэгтгэл, А/176 маягтын мэдээлэл болон баталгаажсан асуумжийн өөрчлөлтийг өөрийн системд JSON хэлбэрээр авна. Нэгтгэлийн API нь зөвхөн нийт тоо, өөрчлөлтийн feed нь асуумжийн хариу, байгууллагын мэдээллийг буцаана.

Үндсэн хаяг

https://inclusivedata.mn

Формат

JSON, UTF-8

Нэвтрэлт

X-Api-Key толгой — заавал

Нэвтрэлт

Хүсэлт бүрд X-Api-Key толгойд түлхүүрээ илгээнэ. Түлхүүрийг системийн админ олгоно — байгууллагынхаа нэр, зорилгыг дурдаад хүсэлт гаргана уу. Түлхүүр нэг л удаа харагдана; алдвал шинээр олгуулна. Энэ баримтын бүх API-д нэг түлхүүр (Нийтийн API) хүрнэ.

curl -H "X-Api-Key: <түлхүүр>" "https://inclusivedata.mn/api/survey-summary"

⚠️ Түлхүүрийг URL-д (?key=) хүлээн авахгүй — хаяг нь лог, хөтчийн түүхэнд үлддэг. Түлхүүрээ клиентийн (хөтчийн) кодонд бүү хадгал, зөвхөн серверээс дууд.

Алдаа

Асуумжийн өгөгдөл татах (өөрчлөлтийн feed)

Байгууллагаас илгээсэн бүх асуумжийн хариу, үнэлгээг татна: шинээр илгээгдсэн, засаж шинэчлэгдсэн, устгагдсан асуумж бүр дараалсан үйл явдал болж гарна. Ноорог орохгүй.

curl --get "https://inclusivedata.mn/api/v1/assessments" \
  -H "X-Api-Key: <түлхүүр>" \
  --data-urlencode "cursor=<хадгалсан nextCursor>" \
  --data-urlencode "limit=100"

Параметр

Үйл явдлын төрөл

Засварлахаар түгжээ нээх нь үйл явдал биш — сүүлд илгээгдсэн хувилбар хүчинтэй хэвээр, дахин илгээгдэхэд updated ирнэ. Утга өөрчлөгдөөгүй хадгалалт үйл явдал үүсгэхгүй.

Жишээ хариу

{
  "items": [
    {
      "event": "updated",
      "changedAt": "2026-10-21T02:15:09.412Z",
      "assessment": {
        "id": "11111111-1111-4111-8111-111111111111",
        "sectionId": "s1",
        "form": "a176",
        "title": "Байгууллагын асуумж",
        "org": "Жишээ байгууллага",
        "entityRegister": "1234567",
        "activity": "Үйлчилгээ",
        "address": "Улаанбаатар",
        "assessedOn": "2026-10-19",
        "lat": 47.9184,
        "lng": 106.9177,
        "answers": { "s1:1": { "value": "yes", "note": "Тайлбар" } },
        "score": 50,
        "answeredCount": 1,
        "status": "submitted",
        "submittedAt": "2026-10-20T08:00:00+00:00",
        "createdAt": "2026-10-18T08:00:00+00:00"
      }
    },
    {
      "event": "deleted",
      "changedAt": "2026-10-21T02:16:40.003Z",
      "assessment": { "id": "22222222-2222-4222-8222-222222222222" }
    }
  ],
  "count": 2,
  "nextCursor": "1287",
  "hasMore": false
}

Талбарууд

Бөглөсөн хүний профайл, хувийн регистр, утас, баталгаажуулалтын мэдээлэл гарахгүй. Медиа файл татахгүй — зөвхөн URL.

Poll хийх алгоритм

1. Хадгалсан nextCursor-оо уншина; анхны удаа cursor өгөхгүй.
2. Хуудас авч items-ийг дарааллаар нь боловсруулна: created/updated → upsert, deleted → устгах.
3. Өгөгдөл болон шинэ nextCursor-ыг нэг transaction-д хадгална.
4. hasMore=true бол дараагийн хуудсыг шууд татна; false бол дараагийн poll хүртэл хүлээнэ (жишээ нь 1–5 минут).
5. Timeout, 5xx үед сүүлд хадгалсан cursor-оос дахин татна — давхар ирсэн үйл явдал upsert тул аюулгүй. 503-ийн Retry-After-ыг дагана.

Үйл явдлууд commit хийгдсэн дарааллаар гарна — огноо, ID-ийн дарааллаар биш. Хожуу илгээгдсэн хуучин асуумж ч алгасагдахгүй. Хуудасны хэмжээ limit-ээс бага байж болох тул зөвхөн hasMore-оор үргэлжлүүлнэ.

Асуумжийн ерөнхий тоо

Гадны самбарт: баталгаажсан үнэлгээ, байгууллага, дундаж эрсдэл, орчин ба аймгаар задаргаа.

curl -H "X-Api-Key: <түлхүүр>" "https://inclusivedata.mn/api/survey-summary"

Хариуны талбарууд

А/176 маягтын дата

22 эрсдэлийн орчин тус бүрээр илэрсэн эрсдэл, шийдвэрлэлт.

curl -H "X-Api-Key: <түлхүүр>" "https://inclusivedata.mn/api/survey-report"

Хариуны талбарууд