Веб сервис

Ангиллын API бүртгэлтэй токен шаардана. Токеныг Token авах цэснээс үүсгэнэ. Өгөгдлийн санд бүртгэгдсэн токеныг олон удаа ашиглаж болно. Хайлтын хуудас нээлттэй өгөгдлөөс ажиллана.

Суурь зам

/api/Classification/v1

Бүртгэлд бичигдсэн эх хаяг: https://api.1212.mn/Classification/v1

Нэвтрэлт

  • POST /api/tokensJSON: email, organization
  • X-API-Key: token
  • Authorization: Basic base64(email:token)

Бүх ангиллын зам (CL09, levels орно) түлхүүр шаардана. Нэг түлхүүрээр минутад 120 хүсэлт илгээж болно; хэтэрвэл 429 болон Retry-After буцаана. Доорх жишээний ORIGIN-ыг сайтын хаягаар солино.

curl -H "X-API-Key: TOKEN" \
  "ORIGIN/api/Classification/v1/Classifications/CL09/Divisions?parents=A&page=1&limit=20"

curl -H "Authorization: Basic BASE64(email:token)" \
  "ORIGIN/api/Classification/v1/Classifications/CL09/Classes/0111"

Түвшин

  • 1. Салбар · Section/Classifications/CL09/Sections · ^[A-V]$ · жишээ A · 22 код
  • 2. Дэд салбар · Division/Classifications/CL09/Divisions · ^\d{2}$ · жишээ 01 · 87 код
  • 3. Бүлэг · Group/Classifications/CL09/Groups · ^\d{3}$ · жишээ 011 · 258 код
  • 4. Анги · Class/Classifications/CL09/Classes · ^\d{4}$ · жишээ 0111 · 464 код
  • 5. Дэд анги · Subclass/Classifications/CL09/Subclasses · ^\d{4}\.\d{1,2}$ · жишээ 0144.1 · 204 код
  • 6. Тодорхойлолт · Definition/Classifications/CL09/Definition · 1035 код

Замууд

  • GET /Classifications/CL09ангиллын бүртгэл, түвшин, тоо
  • GET /Classifications/CL09/levelsтүвшний жагсаалт (зам, формат, жишээ, тоо)
  • GET /Classifications/CL09/Sectionsсалбарын жагсаалт
  • GET /Classifications/CL09/Divisionsдэд салбарын жагсаалт
  • GET /Classifications/CL09/Groupsбүлгийн жагсаалт
  • GET /Classifications/CL09/Classesангийн жагсаалт
  • GET /Classifications/CL09/Subclassesдэд ангийн жагсаалт
  • GET /Classifications/CL09/Definitionбүх кодын тодорхойлолт (include_notes анхдагч true)
  • GET /Classifications/CL09/{Түвшин}/{code}нэг код тайлбар, дэд кодын хамт (жишээ: /Classes/0111)
  • GET /Classifications/CL09/codes/{code}түвшин мэдэхгүй кодыг форматаар нь таньж авах
  • GET /Classifications/CL09/tree?parent={code}&depth={1-5}модон бүтэц; parent байхгүй бол бүх салбараас
  • GET /Classifications/CL09/validate?code={code}код байгаа эсэх, түвшин, формат (үргэлж 200)
  • GET /Classifications/CL09/export?format=csv&level=allбүтнээр татах (доорх «Бүтнээр татах» хэсгийг харна)

Түвшний замын нэр том жижиг үсэг ялгахгүй (classes = Classes). Кодын жагсаалт ангиллын дарааллаар эрэмбэлэгдэнэ.

Жагсаалтын параметр

  • qнэрэнд агуулагдах үг эсвэл кодын эхлэл (жишээ: Сүү, 014)
  • parentsдээд түвшний код, таслалаар олныг (жишээ: A, 01, 0144). Sections-д үл хамаарна
  • include_notestrue | false, анхдагч false — тодорхойлолтыг definition талбарт оруулна
  • pageхуудас, анхдагч 1
  • limitхуудасны хэмжээ, анхдагч 20, 1–100

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

  • codeкод
  • level, levelEn, levelMnтүвшний дугаар ба нэр
  • nameMn, nameEnнэр; англи нэр эх файлд байхгүй тул null
  • parentCode, sectionCodeшууд дээд код, салбарын код
  • pathсалбараас тухайн код хүртэлх кодууд
  • isLeaf, childCountдоод түвшин байхгүй эсэх, шууд дэд кодын тоо
  • definitionтодорхойлолт (include_notes=true эсвэл нэг кодын хүсэлтэд)
  • childrenшууд дэд кодууд (зөвхөн нэг кодын хүсэлтэд)
  • page, limit, total, pages, itemsжагсаалтын хуудаслалт

Бүтнээр татах

  • formatcsv (UTF-8, BOM-тэй тул Excel монгол үсгийг зөв нээнэ) эсвэл json. Бусад утга — 400
  • levelall — бүх түвшин (1035 мөр). Нэг түвшин: section / 1 / Салбар, division / 2, group / 3, class / 4, subclass / 5. Бусад утга — 400

CSV-ийн толгой мөр: Код,Түвшин,Дэд түвшний код,Салбар,Нэр. Мөрүүд ангиллын дарааллаар (салбар A, түүний дэд салбар, бүлэг, анги, дэд анги, дараа нь салбар B …) байна. Тодорхойлолтын текст CSV-д орохгүй; түүнийг /Classifications/CL09/Definition замаас авна. JSON хариултын items ижил таван талбартай: code, levelMn, parentCode, sectionCode, nameMn.

  • Кодангиллын код (A, 01, 011, 0111, 0144.1)
  • ТүвшинСалбар, Дэд салбар, Бүлэг, Анги, Дэд анги
  • Дэд түвшний кодшууд дээд түвшний код (01 → A, 0144.1 → 0144); салбарт хоосон
  • Салбарсалбарын үсэг (A–V)
  • Нэрмонгол нэр
curl -H "X-API-Key: TOKEN" -o CL09.csv \
  "ORIGIN/api/Classification/v1/Classifications/CL09/export?format=csv&level=all"

Код,Түвшин,Дэд түвшний код,Салбар,Нэр
A,Салбар,,A,ХӨДӨӨ АЖ АХУЙ, ОЙН АЖ АХУЙ, ЗАГАС БАРИЛТ ...
01,Дэд салбар,A,A,...
0144.1,Дэд анги,0144,A,Хонь өсгөн үржүүлэх

Алдааны код

  • 400 INVALID_CODE_FORMATкод аль ч түвшний форматад тохирохгүй
  • 400 INVALID_PARAMETERpage, limit, include_notes, depth, format, level зэрэг параметр буруу
  • 401 UNAUTHORIZEDAPI түлхүүр байхгүй эсвэл буруу
  • 404 CODE_NOT_FOUNDформат зөв боловч код ангилалд байхгүй
  • 422 LEVEL_MISMATCHкод өөр түвшний формат (жишээ: /Sections/01)
  • 429 RATE_LIMITEDхүсэлтийн хязгаар хэтэрсэн; Retry-After толгойг харна
{ "error": { "code": "LEVEL_MISMATCH", "message": "..." } }