Անցնել բովանդակությանը
v1
REST
Կապված է ՊԵԿ-ին

Փաստաթղթեր ծրագրավորողների համար

Գրանցեք վաճառքներ, կանխավճարներ և վերադարձներ Հայաստանի ՊԵԿ-ում ցանկացած տեխնոլոգիական փաթեթից։

Հիմնական URLhttps://vcr.am/api/v1

Արագ մեկնարկ

Գրանցեք վաճառք մեկ 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" }
    }
  }'

Ստեղծված է աշխատանքային ինտեգրումների համար

REST՝ JSON-ի վրա
Վիճակազուրկ JSON վերջնակետեր՝ կանչելի ցանկացած լեզվից և շրջանակից։
Տիպավորված Node.js և PHP SDK-ներ
Վերջից վերջ տիպավորված հաճախորդներ npm-ում և Packagist-ում՝ պատրաստ ինչպես Node.js, այնպես էլ PHP սերվերի կոդի համար։
Նույնականացում API բանալիով
Թարմացվող API բանալիներ, որոնք կառավարվում են անձնական էջից։
Դրամարկղի ամբողջական API
Վաճառք, կանխավճար, վերադարձ և կտրոններ՝ մեկ հետևողական ինտերֆեյսով։

Ինչ պետք է տրամադրի ձեր համակարգը

Մինչ ինտեգրումը, համոզվեք, որ յուրաքանչյուր վաճառք պարունակում է ՊԵԿ-ի պահանջվող տվյալները։

Դասակարգչի կոդ
Ապրանքների համար՝ ապրանքային դասակարգչից, ծառայությունների համար՝ տնտեսական գործունեության դասակարգչից։
Չափման միավոր
կգ, հատ, մ², ժամ, ծառայություն, աշխատանք և այլն։
Բաժնի ID
Որտեղ գրանցել վաճառքը ձեր դրամարկղում։
Գանձապահի ID
Ով է գրանցում վաճառքը։

Նույնականացում

Յուրաքանչյուր հարցում պետք է պարունակի ձեր API բանալին X-API-Key վերնագրում։

X-API-Key: your_api_key

Ստեղծեք և թարմացրեք 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