Արագ մեկնարկ
Գրանցեք վաճառք մեկ POST հարցումով։
bash
curl https://vcr.am/api/v1/sales \
-H "X-API-KEY: $VCR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"cashier": { "id": 1 },
"items": [{
"offer": { "externalId": "SKU-001" },
"department": { "id": 1 },
"quantity": 1,
"price": 20000,
"unit": "pc"
}],
"amount": { "nonCash": 20000 },
"buyer": {
"type": "individual",
"receipt": { "email": "buyer@example.com", "language": "en" }
}
}'Ստեղծված է աշխատանքային ինտեգրումների համար
REST՝ JSON-ի վրա
Վիճակազուրկ JSON վերջնակետեր՝ կանչելի ցանկացած լեզվից և շրջանակից։
Տիպավորված Node.js SDK
Վերջից վերջ տիպավորված հաճախորդ npm-ում՝ պատրաստ ձեր սերվերի կոդի համար։
Նույնականացում API բանալիով
Թարմացվող API բանալիներ, որոնք կառավարվում են անձնական էջից։
Դրամարկղի ամբողջական API
Վաճառք, կանխավճար, վերադարձ և կտրոններ՝ մեկ հետևողական ինտերֆեյսով։
Ինչ պետք է տրամադրի ձեր համակարգը
Մինչ ինտեգրումը, համոզվեք, որ յուրաքանչյուր վաճառք պարունակում է ՊԵԿ-ի պահանջվող տվյալները։
Դասակարգչի կոդ
Ապրանքների համար՝ ապրանքային դասակարգչից, ծառայությունների համար՝ տնտեսական գործունեության դասակարգչից։
Չափման միավոր
կգ, հատ, մ², ժամ, ծառայություն, աշխատանք և այլն։
Բաժնի ID
Որտեղ գրանցել վաճառքը ձեր դրամարկղում։
Գանձապահի ID
Ով է գրանցում վաճառքը։
Նույնականացում
Յուրաքանչյուր հարցում պետք է պարունակի ձեր API բանալին X-API-KEY վերնագրում։
X-API-KEY: your_api_keyՍտեղծեք և թարմացրեք API բանալիները ձեր դրամարկղի կարգավորումներում։
Պահեք API բանալին գաղտնի
Մի տեղադրեք այն հաճախորդի կողմի կոդում, հանրային շտեմարաններում կամ ընդհանուր մատյաններում։ Եթե բանալին արտահոսել է՝ անմիջապես փոխարինեք այն դրամարկղի կարգավորումներում։
Սխալներ
Սխալները վերադարձվում են ստանդարտ HTTP կարգավիճակի կոդերով և JSON մարմնով՝ մանրամասներով։
| Կարգավիճակ | Անվանում | Երբ է առաջանում |
|---|---|---|
400 | Սխալ հարցում | Սխալ ձևաչափի մարմին կամ սխեմայի վավերացման ձախողում։ |
401 | Չնույնականացված | API բանալին բացակայում է կամ անվավեր է։ |
403 | Արգելված է | Այս բանալին չունի հասանելիություն տվյալ ռեսուրսին։ |
404 | Չի գտնվել | Հարցվող ռեսուրսը գոյություն չունի։ |
500 | Ներքին սխալ | Անսպասելի սխալ մեր կողմից։ Կրկնեք՝ էքսպոնենցիալ հետաձգումով։ |