Արագ մեկնարկ
Գրանցեք վաճառք մեկ POST հարցումով։
bash
curl https://vcr.am/api/v1/sales \
-H "X-API-Key: $VCR_AM_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" }
}
}'Սկսեք առանց ՊԵԿ-ի վկայագրերի
Փորձնական դրամարկղը գրանցման համարը ստանում է ստեղծման պահին՝ առանց ՊԵԿ-ի հետ վկայագրերի փոխանակման և առանց սպասելու։ Նույն բազային URL-ը, նույն էնդփոինթները, բանալու նույն տրամաբանությունը. տարբերվում են միայն կտրոնները՝ նշվում են TEST-ով և երբեք չեն ներկայացվում։
- 1Կառավարման վահանակում բացեք «Դրամարկղներ», սեղմեք «Ստեղծել դրամարկղ» և ընտրեք «Փորձնական դրամարկղ»։ Ստեղծեք այնքան, որքան պետք է։
- 2Այդ դրամարկղի վրա ստեղծեք API բանալի։ Բանալին կապված է մեկ դրամարկղի հետ, ուստի աշխատանքային դրամարկղից վերցրածը կշարունակի 403 վերադարձնել։
- 3Կանչեք նույն էնդփոինթները նույն բազային URL-ով։ Երբ պատրաստ լինեք իրական ֆիսկալացման, ստեղծեք աշխատանքային դրամարկղ և փոխարինեք բանալին։
Ստեղծված է աշխատանքային ինտեգրումների համար
REST՝ JSON-ի վրա
Վիճակազուրկ JSON վերջնակետեր՝ կանչելի ցանկացած լեզվից և շրջանակից։
Տիպավորված Node.js և PHP SDK-ներ
Վերջից վերջ տիպավորված հաճախորդներ npm-ում և Packagist-ում՝ պատրաստ ինչպես Node.js, այնպես էլ PHP սերվերի կոդի համար։
Նույնականացում API բանալիով
Թարմացվող API բանալիներ, որոնք կառավարվում են անձնական էջից։
Դրամարկղի ամբողջական API
Վաճառք, կանխավճար, վերադարձ և կտրոններ՝ մեկ հետևողական ինտերֆեյսով։
Ինչ պետք է տրամադրի ձեր համակարգը
Մինչ ինտեգրումը, համոզվեք, որ յուրաքանչյուր վաճառք պարունակում է ՊԵԿ-ի պահանջվող տվյալները։
Դասակարգչի կոդ
Ապրանքների համար՝ ապրանքային դասակարգչից, ծառայությունների համար՝ տնտեսական գործունեության դասակարգչից։
Չափման միավոր
կգ, հատ, մ², ժամ, ծառայություն, աշխատանք և այլն։
Բաժնի ID
Որտեղ գրանցել վաճառքը ձեր դրամարկղում — և ինչ հարկման ռեժիմ կնշվի չեկում։ Ոչ պարտադիր՝ եթե չփոխանցեք, տողը կվերցնի իր ապրանքի բաժինը։
Գանձապահի ID
Ով է գրանցում վաճառքը։
Նույնականացում
Յուրաքանչյուր հարցում պետք է պարունակի ձեր API բանալին X-API-Key վերնագրում։ Միակ բացառությունը GET /exchange-rate-ն է՝ այն հանրային է և բանալի չի պահանջում։
X-API-Key: your_api_keyՍտեղծեք և թարմացրեք API բանալիները ձեր դրամարկղի կարգավորումներում։
Պահեք API բանալին գաղտնի
Մի տեղադրեք այն հաճախորդի կողմի կոդում, հանրային շտեմարաններում կամ ընդհանուր մատյաններում։ Եթե բանալին արտահոսել է՝ անմիջապես փոխարինեք այն դրամարկղի կարգավորումներում։
Սխալներ
Սխալները վերադարձվում են ստանդարտ HTTP կարգավիճակի կոդերով և JSON մարմնով՝ մանրամասներով։
| Կարգավիճակ | Անվանում | Երբ է առաջանում |
|---|---|---|
400 | Սխալ հարցում | Սխալ ձևաչափի մարմին կամ սխեմայի վավերացման ձախողում։ |
401 | Չնույնականացված | API բանալին բացակայում է կամ անվավեր է։ |
403 | Արգելված է | Դրամարկղը դեռ չի կարող փաստաթղթեր ներկայացնել՝ գրանցման համար չկա կամ այն ակտիվացված չէ ՊԵԿ-ում։ |
404 | Չի գտնվել | Հարցվող ռեսուրսը գոյություն չունի։ |
500 | Ներքին սխալ | Անսպասելի սխալ մեր կողմից։ Կրկնեք՝ էքսպոնենցիալ հետաձգումով։ |
Շարունակեք ստեղծել
API բրաուզեր
Ինտերակտիվ OpenAPI դիտարկիչ։
Node.js / TypeScript
Next.js, NestJS, Express, Bun, Deno, սովորական Node.js
PHP
Symfony, WordPress, Bitrix, սովորական PHP
WooCommerce
WordPress + WooCommerce խանութ