17. İnteqrasiya API-si və API açarları

İnteqrasiya API-si öz proqramınızın, cədvəlinizin və ya skriptinizin layihə məlumatlarını avtomatik oxumasına imkan verir: layihə siyahısı, kabel və material siyahıları, paylayıcı lövhələrin dövrə cədvəli və klemm siyahısı, miqdar hesabatı və plan paketinin yığılması. API yalnız oxuyur: rəsmi və ya layihəni heç vaxt dəyişmir.

API açarını kim ala bilər

API girişini operator hesab üzrə aktivləşdirir. Hesabınıza giriş verildikdən sonra Profil səhifəsində API açarları kartı görünür; giriş olmadan bu kart gizlidir. Bir hesabın eyni anda ən çox 5 aktiv açarı ola bilər.

Açar sizinlə eyni layihələri görür: öz layihələrinizi və sorğu üzrə sizinlə paylaşılanları. Paylaşılmış layihənin siyahıları və hesabatı yalnız paylaşım ixracı da icazə verirsə qaytarılır.

Açarın yaradılması

Profil səhifəsinin API açarları kartında Yeni açar düyməsini basın.
Açara ad verin (məsələn, onu istifadə edəcək proqramın adı).
Əhatə bölməsini seçin: Layihələri oxumaq layihə siyahısını və layihə məlumatlarını, Sənədləri oxumaq siyahıları, hesabatı və plan paketini verir. Yalnız proqramın həqiqətən ehtiyac duyduğunu seçin.
Bitmə müddəti bölməsini seçin: 30, 90 və ya 365 gün. Müddəti bitmiş açar işləməyi dayandırır; əvəzinə yenisini yaradın.
Cari parolunuzu daxil edin (parolsuz hesab üçün təzə giriş lazımdır). İlk açar üçün API istifadə şərtlərini qəbul edin.

Yaradıldıqdan sonra açar yalnız bir dəfə göstərilir: onu kopyalayın və təhlükəsiz yerdə saxlayın. Sonradan siyahıda yalnız prefiksi (avk_…), yaradılma və bitmə tarixləri, son istifadə və çağırışların sayı görünür. Yeni açar haqqında e-poçt bildirişi də göndəririk (açarın özü olmadan).

Açarın ləğv edilməsi

Açarın yanındakı Ləğv et düyməsi onu dərhal istifadəyə yararsız edir; bunu geri qaytarmaq olmaz. Açarı artıq istifadə etmirsinizsə, onu istifadə edən proqramı sonlandırırsınızsa və ya sızdığından şübhələnirsinizsə, ləğv edin.

Təhlükəsizlik məsləhətləri

Açara parolunuz kimi yanaşın: onu bilən hər kəs əhatə dairəsi daxilində layihələrinizi oxuya bilər.
Onu mənbə kodunda deyil, sirr saxlayıcısında (parol meneceri, serverin mühit dəyişəni və ya CI sirri) saxlayın: heç vaxt git anbarına, paylaşılan cədvələ və ya e-poçta qoymayın.
Brauzerdə işləyən kodda istifadə etməyin (veb səhifə, brauzer əlavəsi): orada hər kəs onu oxuya bilər. Açarın yeri serverdə, skriptdə və ya masaüstü proqramdadır.
Hər proqrama ən dar əhatə dairəsi və qısa bitmə müddəti ilə ayrıca açar verin ki, bir açarın ləğvi başqasını dayandırmasın.

Proqramdan istifadə

Açar sorğunun başlığında Bearer token kimi göndərilir: Authorization: Bearer avk_…. Son nöqtələr /api/v1/ altındadır (məsələn, GET /api/v1/projects) və JSON ilə cavab verir. OpenAPI formatında tam təsvir /api/v1/openapi.json ünvanında mövcuddur; əksər tərtibatçı alətləri onu idxal edə bilir.

Çağırışların sayı açar və hesab üzrə məhdudlaşdırılıb (susmaya görə dəqiqədə 60 və gündə 10 000); həddi aşdıqda server 429 ilə cavab verir, bir az gözləyin. Vebsaytda giriş (cookie) API-ni açmır, açar isə sizi veb interfeysə daxil etmir.