Энэхүү хэсэгт хуулганы сервисийг хэрхэн ашиглах талаар болон хүсэлтүүдийг хэрхэн илгээх талаар тайлбар бичвэрүүд байна.
Үндсэн URL: https://<сервисийн ip хаяг>:3000/v1
Энэхүү сервисийн ажиллах хост, статик файлын зам зэргийг орчны хувьсагчаар дамжууулан тохируулах боломжтой ба тохируулж өгөөгүй бол дараах үндсэн утгууд (default values) -ыг авна.
HOSTNAME="http://localhost:3000"
STATICDIR="/static/" # /static/ondo.png
Гүйлгээний тайлбаруудыг дахин давтагдашгүй дугаартай map/dict/object хэлбэртэйгээр эсвэл тэмдэгт мөрийн жагсаалт хэлбэрээр илгээж болох ба тухайн мөрөөс мерчантын мэдээллийг таньж чадсан тохиолдолд нэр болон логоны хаягийг буцаана. Хэрэв оролт нь тэмдэгт мөрийн жагсаалт бол дараалал нь хадгалагдан, хариу нь 0 -ээс эхэлсэн дэс дугаартайгаар буцна.
Хэрэв мерчантыг таньж чадаагүй бол хариу нь тухайн мөрийн харгалзах дахин давтагдашгүй утга дээр хоосон (null) утга буцаана.
Object хэлбэрээр:
{
"1": "ККТТ ХХК, qpay 628608531810999 ОНДО 30000 TRX: 240.00 ₮",
"2": "ДИЖИТАЛ КОНЦЕПТ ХХК, qpay 108231972319458, 375250418090533, 1181, 87027864, online",
"3": "ТАВАН БОГД ФҮҮДС ПИЦЦА, qpay 844344859134938, РН15 Kass-2",
"4": "СКАЙХАЙПЕРМАРКЕТ ХХК, qpay 767185052602573, 010005160, EMART_CHINGES",
"5": "ККТТ, qpay 200000565347210 MONPAY174411241810627091 1 12065270",
"6": "ККТТ ХХК, qpay 337169089648646 Миний Дэлгүүр 34115 TRX: 238.81 ₮",
"7": "ККТТ ХХК, qpay 614924185829586 АРИГ РАМЕН 28800 TRX: 201.60 ₮",
"8": "ККТТ ХХК, qpay 200000565359795 INF_GOODPRICE 371023",
"9": "ЮНИТЕЛ ХХК, qpay 200000565359276 V055W908J814 001 406410384",
"10": "МОБИКОМ КОРПОРАЦИ ХХК, qpay 200000565361352 MBA_P174411411914854 1 PREPAID"
}
эсвэл жагсаалт хэлбэрээр:
[
"ККТТ ХХК, qpay 628608531810999 ОНДО 30000 TRX: 240.00 ₮",
"ДИЖИТАЛ КОНЦЕПТ ХХК, qpay 108231972319458, 375250418090533, 1181, 87027864, online",
"ТАВАН БОГД ФҮҮДС ПИЦЦА, qpay 844344859134938, РН15 Kass-2",
"СКАЙХАЙПЕРМАРКЕТ ХХК, qpay 767185052602573, 010005160, EMART_CHINGES",
"ККТТ, qpay 200000565347210 MONPAY174411241810627091 1 12065270",
"ККТТ ХХК, qpay 337169089648646 Миний Дэлгүүр 34115 TRX: 238.81 ₮",
"ККТТ ХХК, qpay 614924185829586 АРИГ РАМЕН 28800 TRX: 201.60 ₮",
"ККТТ ХХК, qpay 200000565359795 INF_GOODPRICE 371023",
"ЮНИТЕЛ ХХК, qpay 200000565359276 V055W908J814 001 406410384",
"МОБИКОМ КОРПОРАЦИ ХХК, qpay 200000565361352 MBA_P174411411914854 1 PREPAID"
]
Object хэлбэрийн хариу:
{
"1": {
"logo": "http://localhost:3000/static/ondo.png",
"name": "ONDO"
},
"2": {
"logo": "http://localhost:3000/static/gs25.png",
"name": "GS25"
},
"3": {
"logo": "http://localhost:3000/static/pizzahut.png",
"name": "Pizza Hut"
},
"4": {
"logo": "http://localhost:3000/static/emart.png",
"name": "Emart"
},
"5": null,
"6": {
"logo": "http://localhost:3000/static/miniidelguur.png",
"name": "Миний сүлжээ"
},
"7": {
"logo": "http://localhost:3000/static/ariganya.png",
"name": "Ариг Аня"
},
"8": {
"logo": "http://localhost:3000/static/goodprice.png",
"name": "Good Price"
},
"9": {
"logo": "http://localhost:3000/static/unitel.png",
"name": "Unitel"
},
"10": {
"logo": "http://localhost:3000/static/mobicom.png",
"name": "Mobicom"
}
}
эсвэл
[
{
"logo": "http://localhost:3000/static/ondo.png",
"name": "ONDO"
},
{
"logo": "http://localhost:3000/static/gs25.png",
"name": "GS25"
},
{
"logo": "http://localhost:3000/static/pizzahut.png",
"name": "Pizza Hut"
},
null,
{
"logo": "http://localhost:3000/static/monpay.png",
"name": "Monpay"
},
{
"logo": "http://localhost:3000/static/miniidelguur.png",
"name": "Миний сүлжээ"
},
{
"logo": "http://localhost:3000/static/ariganya.png",
"name": "Ариг Аня"
},
{
"logo": "http://localhost:3000/static/goodprice.png",
"name": "Good Price"
},
{
"logo": "http://localhost:3000/static/unitel.png",
"name": "Unitel"
},
{
"logo": "http://localhost:3000/static/mobicom.png",
"name": "Mobicom"
}
]
curl --location 'http://statement-45.117.32.201.nip.io/v1/match' \
--header 'Content-Type: application/json' \
--header 'Cookie: csrftoken=DV3cRKA0KRwu5paxjXNCOkMY0CwQSoFp' \
--data '{
"1": "ККТТ ХХК, qpay 628608531810999 ОНДО 30000 TRX: 240.00 ₮",
"2": "ДИЖИТАЛ КОНЦЕПТ ХХК, qpay 108231972319458, 375250418090533, 1181, 87027864, online",
"3": "ТАВАН БОГД ФҮҮДС ПИЦЦА, qpay 844344859134938, РН15 Kass-2",
"4": "СКАЙХАЙПЕРМАРКЕТ ХХК, qpay 767185052602573, 010005160, EMART_CHINGES",
"5": "nonexistent",
"6": "ККТТ ХХК, qpay 337169089648646 Миний Дэлгүүр 34115 TRX: 238.81 ₮",
"7": "ККТТ ХХК, qpay 614924185829586 АРИГ РАМЕН 28800 TRX: 201.60 ₮",
"8": "ККТТ ХХК, qpay 200000565359795 INF_GOODPRICE 371023",
"9": "ЮНИТЕЛ ХХК, qpay 200000565359276 V055W908J814 001 406410384",
"10": "МОБИКОМ КОРПОРАЦИ ХХК, qpay 200000565361352 MBA_P174411411914854 1 PREPAID"
}'
эсвэл
curl --location 'localhost:3000/v1/match' \
--header 'Content-Type: application/json' \
--data '[
"ККТТ ХХК, qpay 628608531810999 ОНДО 30000 TRX: 240.00 ₮",
"ДИЖИТАЛ КОНЦЕПТ ХХК, qpay 108231972319458, 375250418090533, 1181, 87027864, online",
"ТАВАН БОГД ФҮҮДС ПИЦЦА, qpay 844344859134938, РН15 Kass-2",
"nonexistent",
"ККТТ, qpay 200000565347210 MONPAY174411241810627091 1 12065270",
"ККТТ ХХК, qpay 337169089648646 Миний Дэлгүүр 34115 TRX: 238.81 ₮",
"ККТТ ХХК, qpay 614924185829586 АРИГ РАМЕН 28800 TRX: 201.60 ₮",
"ККТТ ХХК, qpay 200000565359795 INF_GOODPRICE 371023",
"ЮНИТЕЛ ХХК, qpay 200000565359276 V055W908J814 001 406410384",
"МОБИКОМ КОРПОРАЦИ ХХК, qpay 200000565361352 MBA_P174411411914854 1 PREPAID"
]'
Энэхүү API сервис нь стандарт HTTP протоколын хариу кодуудыг ашиглан хүсэлтийн амжилттай, алдаатай төлөвүүдийг мэдээллэнэ. Үүнд:
| Код | Тайлбар |
|---|---|
| 200 | Амжилттай |
| 400 | Буруу хүсэлтийн утга |
| 404 | Зам олдоогүй |
| 405 | HTTP Method буруу |
| 500 | Дотоод серверийн алдаа |