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'ни ачпайт, ал эми ачкыч сизди веб-интерфейске киргизбейт.