API tokenləri

Wolkra API tokenləri wk_ ilə başlayan, layihə səviyyəsində işləyən açarlardır. https://api.wolkra.com/v1 ünvanındakı REST API-ni çağırmaq üçün tokeni Authorization: Bearer başlığında göndərin. Token oxuma və ya oxuma/yazma girişi, istəyə bağlı IP icazə siyahısı və istəyə bağlı bitmə tarixi ilə yaradılır.

Token yaradın

1. Konsolda tokenin giriş əldə edəcəyi layihəyə keçin.
2. API tokens bölməsini açın və Create token seçin.
3. Ona harada istifadə olunduğunu göstərən ad verin, məsələn, ci-deploy və ya monitoring-readonly.
4. Giriş səviyyəsini seçin:
   • Oxuma: yalnız resursları siyahılamaq və baxmaq.
   • Oxuma/yazma: həmçinin resursları yaratmaq, dəyişmək və silmək.
5. İstəyə görə IP icazə siyahısı əlavə edin: yalnız bu ünvanlardan və ya diapazonlardan gələn sorğular qəbul olunur.
6. İstəyə görə bitmə tarixi təyin edin.
7. Tokeni yaradın və dərhal kopyalayın. Onu parol kimi saxlayın, məsələn, secret manager-də və ya CI sisteminizin gizli dəyişənlərində.

İlk sorğunuzu göndərin

Layihədəki serverləri siyahılayın:

curl -H "Authorization: Bearer wk_…" https://api.wolkra.com/v1/servers

Skriptlərdə tokeni əmrin içində deyil, mühit dəyişənində saxlayın:

export WOLKRA_TOKEN='wk_…'
curl -s -H "Authorization: Bearer $WOLKRA_TOKEN" https://api.wolkra.com/v1/servers | jq .

jq (sudo apt install -y jq ilə quraşdırın) JSON cavabını formatlayır.

Resurslar

API konsoldakı resursların eynisini əhatə edir:

Bütün yollar https://api.wolkra.com/v1 ünvanına nisbətəndir. Məsələn, volume-ları siyahılamaq üçün:

curl -s -H "Authorization: Bearer $WOLKRA_TOKEN" https://api.wolkra.com/v1/volumes

Əməliyyatlar (actions)

Serveri işə salmaq və ya volume qoşmaq kimi vaxt aparan dəyişikliklər əməliyyat (action) kimi icra olunur. Dəyişikliyin tamamlandığını güman etmək əvəzinə, skripti davam etdirməzdən əvvəl onların gedişatını /actions ünvanında yoxlayın.

Xətalar

API standart HTTP status kodları ilə cavab verir. Tipik mənalar:

Sazlama zamanı status kodunu çap edin:

curl -s -o /dev/null -w '%{http_code}\n' \
  -H "Authorization: Bearer $WOLKRA_TOKEN" https://api.wolkra.com/v1/servers

Yaxşı təcrübələr

• Hər istifadə üçün bir token. CI üçün bir token, monitorinq üçün başqası, noutbukunuz üçün başqası. Birini ləğv etmək digərlərini pozmur.
• Minimum səlahiyyət. Dashboard-lar və monitorinq üçün oxuma tokenlərindən istifadə edin.
• Ünvana görə məhdudlaşdırın. Sabit serverlərdən və ya CI runner-lərdən istifadə olunan tokenlərə IP icazə siyahısı əlavə edin.
• Tokenlərə bitmə tarixi qoyun, xüsusilə müəyyən layihə və ya ayrılacaq şəxs üçün nəzərdə tutulanlara.
• Tokenləri heç vaxt git-ə commit etməyin. Biri sızarsa, onu dərhal konsolda silin və yenisini yaradın.
• Token siyahısını və təşkilatın fəaliyyət jurnalını vaxtaşırı nəzərdən keçirin.

Tokeni ləğv edin

API tokens bölməsini açın, tokeni tapın və silin. Bundan sonra onunla göndərilən sorğular uğursuz olur.

Avtomatlaşdırma

Skriptlər API-ni birbaşa HTTPS üzərindən çağırır. curl, Python-un requests, Go-nun net/http kitabxanası və ya istənilən HTTP müştərisi işləyir. Serverləri ilk açılışda tam konfiqurasiya etmək üçün API-ni cloud-init user data ilə birləşdirin.

Məhsul səhifəsində ətraflı: API. Hesabın özünü qorumaq üçün hesab təhlükəsizliyi səhifəsinə baxın.