17. Integratsiya API va API kalitlari

Integratsiya API o‘z dasturingiz, jadvalingiz yoki skriptingizga loyiha ma’lumotlarini avtomatik o‘qish imkonini beradi: loyihalar ro‘yxati, kabel va material ro‘yxatlari, taqsimlash shitlarining zanjir jadvali va klemma ro‘yxati, miqdor hisoboti hamda chizma paketini yig‘ish. API faqat o‘qiydi: chizmani yoki loyihani hech qachon o‘zgartirmaydi.

API kalitini kim olishi mumkin

API’dan foydalanishni operator hisob bo‘yicha yoqadi. Hisobingizga ruxsat berilgach, Profil sahifasida API kalitlari kartasi paydo bo‘ladi; ruxsatsiz bu karta yashirin. Bitta hisobda bir vaqtning o‘zida ko‘pi bilan 5 ta faol kalit bo‘lishi mumkin.

Kalit siz bilan bir xil loyihalarni ko‘radi: o‘zingizniki va so‘rov bo‘yicha siz bilan ulashilganlarni. Ulashilgan loyihaning ro‘yxatlari va hisoboti faqat ulashish eksportga ham ruxsat bersa qaytariladi.

Kalit yaratish

Profil sahifasining API kalitlari kartasida Yangi kalit tugmasini bosing.
Kalitga nom bering (masalan, undan foydalanadigan dastur nomi).
Qamrov bandini tanlang: Loyihalarni o‘qish loyihalar ro‘yxati va loyiha ma’lumotlarini, Hujjatlarni o‘qish ro‘yxatlar, hisobot va chizma paketini beradi. Faqat dasturga haqiqatan kerak bo‘lganini tanlang.
Amal qilish muddati bandini tanlang: 30, 90 yoki 365 kun. Muddati o‘tgan kalit ishlamaydi; o‘rniga yangisini yarating.
Joriy parolingizni kiriting (parolsiz hisob uchun yangi kirish kerak). Birinchi kalit uchun API’dan foydalanish shartlarini qabul qiling.

Yaratilgandan so‘ng kalit faqat bir marta ko‘rsatiladi: uni nusxalang va xavfsiz joyda saqlang. Keyin ro‘yxatda faqat uning prefiksi (avk_…), yaratilgan va tugash sanalari, oxirgi foydalanish hamda chaqiruvlar soni ko‘rinadi. Yangi kalit haqida e-pochta xabarnomasini ham yuboramiz (kalitning o‘zisiz).

Kalitni bekor qilish

Kalit yonidagi Bekor qilish tugmasi uni darhol yaroqsiz qiladi; buni qaytarib bo‘lmaydi. Kalitdan endi foydalanmasangiz, uni ishlatgan dasturni to‘xtatsangiz yoki sizib chiqqanidan gumon qilsangiz, bekor qiling.

Xavfsizlik bo‘yicha maslahatlar

Kalitga parolingizdek munosabatda bo‘ling: uni biladigan har kim qamrov doirasida loyihalaringizni o‘qiy oladi.
Uni manba kodida emas, sirlar omborida (parol menejeri, serverning muhit o‘zgaruvchisi yoki CI siri) saqlang: hech qachon git repozitoriysiga, umumiy jadvalga yoki e-pochtaga qo‘ymang.
Brauzerda ishlaydigan kodda ishlatmang (veb-sahifa, brauzer kengaytmasi): u yerda uni istalgan kishi o‘qiy oladi. Kalitning o‘rni serverda, skriptda yoki desktop dasturda.
Har bir dasturga eng tor qamrov va qisqa muddat bilan alohida kalit bering, shunda bitta kalitni bekor qilish boshqasini to‘xtatmaydi.

Dasturdan foydalanish

Kalit so‘rov sarlavhasida Bearer token sifatida yuboriladi: Authorization: Bearer avk_…. Endpointlar /api/v1/ ostida joylashgan (masalan, GET /api/v1/projects) va JSON bilan javob beradi. OpenAPI formatidagi to‘liq tavsif /api/v1/openapi.json manzilida mavjud; ko‘pchilik dasturchi vositalari uni import qila oladi.

Chaqiruvlar soni kalit va hisob bo‘yicha cheklangan (odatda daqiqasiga 60 va kuniga 10 000); oshganda server 429 bilan javob beradi, biroz kuting. Veb-saytga kirish (cookie) API’ni ochmaydi, kalit esa sizni veb-interfeysga kiritmaydi.