17. Ինտեգրման API և API բանալիներ

Ինտեգրացիայի API-ն թույլ է տալիս ձեր սեփական ծրագրին, աղյուսակին կամ սկրիպտին ավտոմատ կարդալ նախագծի տվյալները՝ նախագծերի ցանկը, մալուխների և նյութերի ցուցակները, բաշխիչ վահանակների շղթաների աղյուսակն ու սեղմակների ցանկը, քանակների քաղվածքը և գծագրերի փաթեթի կազմումը։ API-ն միայն կարդում է՝ գծագիրը կամ նախագիծը երբեք չի փոխում։

Ով կարող է API-բանալի ստանալ

API-ի հասանելիությունը հաշվի համար միացնում է օպերատորը։ Երբ ձեր հաշվին հասանելիություն տրվի, Պրոֆիլ էջում հայտնվում է API բանալիներ քարտը. առանց հասանելիության քարտը թաքնված է։ Մեկ հաշիվը միաժամանակ կարող է ունենալ առավելագույնը 5 ակտիվ բանալի։

Բանալին տեսնում է նույն նախագծերը, ինչ դուք՝ ձերը և, խնդրանքով, ձեզ հետ կիսվածները։ Կիսված նախագծի ցուցակները և քաղվածքը տրվում են միայն եթե կիսումը թույլ է տալիս նաև արտահանում։

Բանալու ստեղծում

Պրոֆիլ էջի API բանալիներ քարտում սեղմեք Նոր բանալի կոճակը։
Բանալուն անուն տվեք (օրինակ՝ այն ծրագրի անունը, որը կօգտագործի այն)։
Ընտրեք Շրջանակ. Նախագծերի ընթերցում-ը տալիս է նախագծերի ցանկն ու նախագծի տվյալները, Փաստաթղթերի ընթերցում-ը՝ ցուցակները, քաղվածքը և գծագրերի փաթեթը։ Ընտրեք միայն այն, ինչ ծրագրին իրոք պետք է։
Ընտրեք Ժամկետ՝ 30, 90 կամ 365 օր։ Ժամկետանց բանալին այլևս չի աշխատում. փոխարենը նորը ստեղծեք։
Մուտքագրեք ձեր ընթացիկ գաղտնաբառը (անգաղտնաբառ հաշվի համար պետք է թարմ մուտք)։ Առաջին բանալու համար ընդունեք API-ի օգտագործման պայմանները։

Ստեղծումից հետո բանալին ցուցադրվում է միայն մեկ անգամ. պատճենեք այն և պահեք անվտանգ տեղում։ Հետագայում ցանկում երևում է միայն նրա նախածանցը (avk_…)՝ ստեղծման և ավարտի ամսաթվերով, վերջին օգտագործմամբ և կանչերի քանակով։ Նոր բանալու մասին նաև էլ. փոստով ծանուցում ենք ուղարկում (առանց բանալու)։

Բանալու չեղարկում

Բանալու կողքի Չեղարկել կոճակը այն անմիջապես անօգտագործելի է դարձնում. սա հնարավոր չէ հետ շրջել։ Չեղարկեք բանալին, երբ այլևս չեք օգտագործում, երբ այն օգտագործող ծրագիրը դադարեցնում եք, կամ երբ կասկածում եք, որ այն արտահոսել է։

Անվտանգության խորհուրդներ

Բանալուն վերաբերվեք ինչպես ձեր գաղտնաբառին. այն իմացողը շրջանակի սահմաններում կարող է կարդալ ձեր նախագծերը։
Պահեք գաղտնիքների պահոցում (գաղտնաբառերի կառավարիչ, սերվերի միջավայրի փոփոխական կամ CI-ի գաղտնիք), ոչ թե սկզբնական կոդում. երբեք մի դրեք git-պահոցում, ընդհանուր աղյուսակում կամ էլ. նամակում։
Մի օգտագործեք բրաուզերում աշխատող կոդում (վեբ էջ, բրաուզերի ընդլայնում). այնտեղ ցանկացած մարդ կարող է կարդալ այն։ Բանալու տեղը սերվերում է, սկրիպտում կամ աշխատասեղանի ծրագրում։
Յուրաքանչյուր ծրագրի տվեք առանձին բանալի՝ ամենանեղ շրջանակով և կարճ ժամկետով, որպեսզի մեկ բանալու չեղարկումը ոչինչ չկանգնեցնի։

Օգտագործում ծրագրից

Բանալին հարցման վերնագրում ուղարկվում է որպես Bearer թոքեն. Authorization: Bearer avk_…։ Վերջնակետերը գտնվում են /api/v1/ տակ (օրինակ՝ GET /api/v1/projects) և պատասխանում են JSON-ով։ OpenAPI ձևաչափով լրիվ նկարագրությունը հասանելի է /api/v1/openapi.json հասցեով. մշակողի գործիքների մեծ մասը կարող է ներմուծել այն։

Կանչերի քանակը սահմանափակված է բանալու և հաշվի համար (լռելյայն րոպեում 60 և օրական 10 000). գերազանցելիս սերվերը պատասխանում է 429-ով, ուստի մի քիչ սպասեք։ Վեբկայքում մուտքը (cookie) API-ն չի բացում, իսկ բանալին ձեզ վեբ ինտերֆեյս չի մտցնում։