Ընդհանուր տեղեկություն |
  
|
Ընդհանուր տեղեկություն |
|
URL Endpoint |
URL Swagger |
Ավտորիզացիա (Authorization)
API-ի միջոցով ՀԾ-Առևտուր-9 համակարգի հետ աշխատելու համար անհրաժեշտ է ստանալ միացման գաղտնի բանալին (API Key):
Գաղտնի բանալին կարող է ստեղծել և կառավարել միայն ՀԾ-Առևտուր-9 համակարգի ադմինիստրատորը։
Այն ստանալու համար անհրաժեշտ է կատարել API գաղտնի բանալու ստացում էջում նկարագրված քայլերը:
Գաղտնի բանալին օգտագործվում է բոլոր հարցումներիում (մեթոդներում) որպես հասանելիության պարամետր: Այն անհրաժեշտ է տեղադրել հարցման գլխագրի apiKey դաշտում.
curl -X 'GET' \ 'https://api.armsoft.am/trade/v1/directories/barcodes' \ -H 'accept: text/plain' \ -H 'Accept-Language: hy-AM' \ -H 'apiKey: hJk:|^&99։՛(=0#biWc:' |
Բացառություն է կազմում GET/api/Version ռեսուրսը, որի դեպքում բանալու նշումը չի պահանջվում։
Գաղտնի բանալիների առավելագույն քանակը 10 է։
Բանալին գործում է անժամկետ և մնում է ակտիվ, մինչև դուք այն չհեռացնեք կամ չգեներացնեք նորը։
Եթե բանալին կորել կամ վնասվել է, ապա այն վերականգնել հնարավոր չէ։ Այս դեպքում կարող եք կրկին գեներացնել կամ ստեղծել նորը։
Ուշադրություն! Եթե կա կասկած, որ ձեր բանալին հայտնի է դարձել երրորդ անձանց, հեռացրեք այն և ստեղծեք նորը։
Համակցման մշակման դիտողություններ
Համակցումը մշակելիս պետք է հաշվի առնել հետևյալ կետերը.
•հարցումների և պատասխանների կառուցվածքը և դաշտերի տիպերը պահվում են անփոփոխ
•հնարավոր է նոր դաշտերի ավելացում՝ չխախտելով պատասխանի կառուցվածքը
•հնարավոր է նոր մեթոդների ավելացում
Հարցումների քանակական սահմանափակումներ
API-ն ունի հետևյալ սահմանափակումները.
•առավելագույնը 45 հարցում՝ 3 վայրկյանում մեկ օգտագործողի կողմից
•առավելագույնը 3 զուգահեռ հարցում մեկ օգտագործողի կողմից
•առավելագույնը 8Կբ հարցման գլխագրում
•առավելագույնը 20 Մբ տվյալ մեկ հարցումում
•առավելագույնը 1000 տարր ցանկում (array) մեկ հարցումում
API-ի հասանելիության ավտոմատ անջատում (օգտագործման պայմանների խախտումներ)
API-ի հասանելիությունն ավտոմատ անջատվում է եթե մեկ րոպեում կատարված 200 նույնական հարցումները վերջին մեկ ժամվա ընթացքում ավարտվել են սխալով:
Սակագնային սահմանափակումներ
API-ի համար գործում են սակագնային փաթեթի սահմանափակումներ։ Օգտագործողին հասանելի է API-ի ֆունկցիոնալությունը համաձայն իր համար գործող սակագնային փաթեթի (տես` Մանրամասն - Լրացուցիչ հատվածում)։
HTTP սխալները և դրանց նշանակությունը
Կոդ |
Նկարագրություն |
Նշանակություն |
400 |
Bad Request |
Հարցման կառուցվածքում առկա է սխալ։ |
401 |
Unauthorized |
Հարցման մեջ ավտորիզացիայի գաղտնի բանալին (API Key) նշված չէ կամ այն անվավեր է։ |
403 |
Forbidden |
Դուք չունեք բավարար իրավունք տվյալ ռեսուրսին կամ գործողությանը դիմելու համար։ |
404 |
Not Found |
Հարցվող մեթոդը կամ API ռեսուրսը չի գտնվել։ |
405 |
Method Not Allowed |
Նշված ռեսուրսի համար տվյալ մեթոդը գոյություն չունի։ |
500 |
Internal Server Error |
Համակարգի ներքին սխալ: Հարցման մշակման ընթացքում տեղի է ունեցել չնախատեսված սխալ։ |
503 |
Service Unavailable |
Սերվերի գերբեռնվածության պատճառով ծառայությունը ժամանակավորապես անհասանելի է։ |
Ամսաթվի և ժամի ձևաչափ
Ամսաթիվ և ժամ տեսակի դաշտերը ներկայացվում են որպես տող հետևյալ ձևաչափով (ISO 8601)՝
•առանց ժամի - YYYY-MM-DD
•ժամով (միլիվայրկյանների ճշգրտությամբ) - YYYY-MM-DDTHH:mm:ss.SSSZ
"date": "2026-02-04" "creationDate": "2026-02-04T05:39:04.431Z"
|
Պատասխանի լեզվի կարգավորում
Հարցման գլխագրում կիրառելով Accept-Language դաշտը, դուք կարող եք սահմանել վերադարձվող պատասխանի լեզուն: Կիրառվող լեզուների արժեքներ` hy-AM (լռությամբ արժեքը), en-US, ru-RU:
-H 'Accept-Language: hy-AM' \
|