Токенҳои API

Токенҳои API-и Wolkra калидҳое мебошанд, ки ба лоиҳа маҳдуданд ва бо wk_ оғоз мешаванд. Токенро дар сарлавҳаи Authorization: Bearer фиристед, то REST API-ро дар https://api.wolkra.com/v1 даъват кунед, бо дастрасии хондан ё хондан/навиштан, рӯйхати ихтиёрии иҷозатдодашудаи IP ва санаи ихтиёрии анҷоми мӯҳлат.

Токен созед

1. Дар консол ба лоиҳае гузаред, ки токен бояд ба он дастрасӣ дошта бошад.
2. API tokens-ро кушоед ва Create token-ро интихоб кунед.
3. Ба он номе диҳед, ки нишон диҳад дар куҷо истифода мешавад, масалан ci-deploy ё monitoring-readonly.
4. Сатҳи дастрасиро интихоб кунед:
   • Хондан (Read): танҳо рӯйхат ва дидани захираҳо.
   • Хондан/навиштан (Read/write): инчунин сохтан, тағйир додан ва нест кардани захираҳо.
5. Ба таври ихтиёрӣ рӯйхати иҷозатдодашудаи IP илова кунед: танҳо дархостҳо аз ин суроғаҳо ё диапазонҳо қабул мешаванд.
6. Ба таври ихтиёрӣ санаи анҷоми мӯҳлат-ро муқаррар кунед.
7. Токенро созед ва онро фавран нусха бардоред. Онро мисли парол нигоҳ доред, масалан дар менеҷери махфиятҳо ё дар тағйирёбандаҳои махфии CI-и худ.

Дархости аввалини худро фиристед

Серверҳои лоиҳаро рӯйхат кунед:

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

Дар скриптҳо токенро на дар фармон, балки дар тағйирёбандаи муҳит нигоҳ доред:

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

jq (бо sudo apt install -y jq насб кунед) ҷавоби JSON-ро формат мекунад.

Захираҳо

API ҳамон захираҳоеро дар бар мегирад, ки консол:

Ҳамаи роҳҳо нисбат ба https://api.wolkra.com/v1 мебошанд. Масалан, барои рӯйхат кардани ҳаҷмҳо:

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

Амалҳо

Тағйироте, ки вақт мегиранд, масалан оғоз кардани сервер ё пайваст кардани ҳаҷм, ҳамчун амалҳо (actions) иҷро мешаванд. Пеш аз идома додани скрипт пешрафти онҳоро дар /actions санҷед, ба ҷои он ки гумон кунед тағйирот анҷом ёфтааст.

Хатоҳо

API бо рамзҳои стандартии ҳолати HTTP ҷавоб медиҳад. Маъноҳои маъмул:

Ҳангоми ислоҳи хатоҳо рамзи ҳолатро чоп кунед:

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

Таҷрибаи хуб

• Барои ҳар истифода як токен. Як токен барои CI, дигаре барои мониторинг, дигаре барои ноутбуки шумо. Якеро бекор кунед, бе он ки дигаронро вайрон кунед.
• Камтарин имтиёзҳо. Барои панелҳои назоратӣ ва мониторинг токенҳои хонданро истифода баред.
• Аз рӯи суроға маҳдуд кунед. Барои токенҳое, ки аз серверҳои собит ё CI runner-ҳо истифода мешаванд, рӯйхати иҷозатдодашудаи IP илова кунед.
• Мӯҳлати токенҳоро муқаррар кунед, ки барои лоиҳа ё шахсе пешбинӣ шудаанд, ки баъдтар меравад.
• Ҳеҷ гоҳ токенҳоро ба git commit накунед. Агар яке фош шавад, онро фавран дар консол нест кунед ва токени нав созед.
• Гоҳ-гоҳ рӯйхати токенҳо ва журнали фаъолияти созмонро баррасӣ кунед.

Токенро бекор кунед

API tokens-ро кушоед, токенро ёбед ва онро нест кунед. Аз он лаҳза дархостҳо бо он ноком мешаванд.

Автоматикунонӣ

Скриптҳо API-ро бевосита тавассути HTTPS даъват мекунанд. curl, requests-и Python, net/http-и Go ё ҳар мизоҷи HTTP кор мекунад. API-ро бо cloud-init user data якҷоя кунед, то серверҳоро ҳангоми боршавии аввал пурра танзим кунед.

Маълумоти бештар дар саҳифаи маҳсулот: API. Барои ҳифзи худи ҳисоб ба амнияти ҳисоб нигаред.