Comment on page
⚙
Notly.mn API
notly.mn api ашиглан нотлох боломжтой цахим баримт үүсгэх нь
Notly систем нь датагаа эмх цэгцтэй хадгалж, эргээд хайлт хийхэд хялбар болгох үүднээс дараах байдлаар хадгалдаг.
Хавтас /graduation/: Хэд хэдэн баримт бичгийн олонлог. Ихэвчлэн нэг ангийн төгсөлт, нэг тэнхимийн төгсөлт зэргийг хадгалвал зохистой. Шинээр хавтас/graduation/ үүсгэх зааврыг эндээс үзээрэй.
Ноорог /draft/: Нэг удаагийн оролдлогоор баталгаажуулж буй файлууд. zip файл үүсгээд upload хийж байгаа бол zip доторх файлууд нэг draft болно. 1 pdf файл дангаараа оруулж байгаа бол уг файл дангаараа нэг draft дотор агуулагдана. Draft доторх бүх файл баталгаажсан бол draft дахиж хэрэглэгчид харагдахгүй.
Баримт бичиг /document/: Нэг ширхэг баримт бичиг. Жишээ нь диплом, гэрчилгээ ...
Орчин | URL |
|---|---|
Production /notly/ | |
Production /certify/ |
get
https://notly.mn/service/api/user
/user
Хэрэглэгчийн хувийн мэдээллийн дэлгэрэнгүй
Parameters
Header
x-api-key*
String
API Key
Responses
200: OK
Амжилттай үед
401: Unauthorized
API Key буруу үед
get
https://notly.mn/service/api/v2/certification/
graduation
Хавтсын жагсаалт авах
Parameters
Query
limit
Int
хуудаслалт
offset
Int
offset
Header
x-api-key*
API Key
Responses
200: OK
Амжилттай үед
get
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>
Хавтсын дэлгэрэнгүй авах
Parameters
Path
<graduation_id>*
Хавтсын ID
Header
x-api-key*
API Key
Responses
200: OK
Амжилттай үед
get
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>/document
Хавтас доторх баримт бичгүүдийн жагсаалт авах
Parameters
Path
<graduation_id>*
Хавтсын ID
state
String
баримт бичиг блокчэйн дээрх бичигдсэн эсэхийг илэрхийлэх төлөв ISSUED, REVOKED, PENDING, FAILED
Query
limit
Int
хуудаслалт
offset
Int
offset
Header
x-api-key*
API Key
Responses
200: OK
Амжилттай үед
get
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>/document/<document_id>
Баримт бичгийн дэлгэрэнгүй авах
Parameters
Path
<graduation_id>*
Хавтсын ID
<document_id>*
Баримт бичгийн ID
Header
x-api-key*
API Key
Responses
200: OK
Амжилттай үед
post
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>/document/download
Хавтас доторх баримт бичгүүдээс татаж авах
нэг баримт бичиг бол .pdf хэлбэрээр олон баримт бичиг бол .zip хэлбэрээр татагдана.
Parameters
Path
<graduation_id>*
Хавтсын ID
Header
Content-Type*
application/json
x-api-key*
API Key
Body
document_ids*
Array<String>
Татаж авах баримт бичгүүдийн ID уудыг хүснэгтэд хийн илгээнэ
Responses
200: OK
Амжилттай үед
post
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>/document/issue_single_document
Хавтас дотор баримт бичиг нэмж блокчэйнд баталгаажуулах
Хавтас үүсгэх зааврыг эндээс хараарай.
Нэг баримт бичиг бол .pdf хэлбэрээр олон баримт бичиг бол .zip хэлбэрээр илгээж болно. Энэ хүсэлтээр нэмсэн файл нь блокчэйнд баталгаажих хүртэл хэсэг хугацаа зарцуулагдана. Та дэлгэрэнгүй хүсэлтээр state төлөв нь ISSUED болсон эсэхийг шалгаж болно. ISSUED бол баталгаажсан, FAILED бол ямар нэг алдаа гарсан, PENDING бол баталгаажихыг хүлээж байгаа.
Parameters
Path
<graduation_id>*
Хавтсын ID
Header
Content-Type*
form
x-api-key*
API Key
Body
file*
File
.pdf эсвэл олон .pdf агуулсан .zip файл
Responses
201: Created
Амжилттай үед /нээж жишээ харна уу/
post
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>/document/revoke
Баталгаажсан баримты г хүчингүй болгох
Parameters
Path
<graduation_id>*
Хавтсын ID
Header
Content-Type*
application/json
x-api-key*
API Key
Body
document_ids*
Array<String>
Хүчингүй болгох баримт бичгүүдийн ID уудыг хүснэгтэд хийн илгээнэ
revoke_note*
Хүчингүй болгож буй тайлбар
Responses
200: OK
Амжилттай үед /нээж жишээ харна уу/
post
https://notly.mn/service/api/v2/certification/
graduation/<graduation_id>/document/retry
Баталгаажуулах үед алдаа гарсан баримтыг дахин баталгаажуулах оролдлого хийх
Parameters
Path
<graduation_id>*
Хавтсын ID
Header
Content-Type*
application/json
x-api-key*
API Key
Body
document_ids*
Array<String>
Дахин баталгаажууалх баримт бичгүүдийн ID уудыг хүснэгтэд хийн илгээнэ
Responses
200: OK
Амжилттай үед