API-и Wolkra як REST API дар суроғаи https://api.wolkra.com/v1 аст, ки ба шумо имкон медиҳад серверҳо, ҳаҷмҳо, шабакаҳо, firewall-ҳо ва мувозинаткунандаҳои сарбориро аз коди худ созед ва идора кунед. Дархостҳо бо токенҳои дар доираи лоиҳа тасдиқ мешаванд, ки онҳоро метавонед танҳо ба хондан, ба суроғаҳои муайяни IP ва ба мӯҳлати муайян маҳдуд кунед.
API чиро фаро мегирад
API ҳамон корҳоеро такрор мекунад, ки шумо дар консол анҷом медиҳед. Вазифаҳои маъмул:
- Сохтан, калон кардан, аз нав насб кардан, фаъол ё хомӯш кардан ва нест кардани серверҳои абрӣ
- Сохтан, пайваст кардан, калон кардан ва ҷудо кардани ҳаҷмҳои анбори блокӣ
- Фаъол кардани нусхаҳои эҳтиётӣ ва гирифтани snapshot-ҳо
- Танзими шабакаҳои хусусӣ ва NAT gateway-ҳо
- Идораи firewall-ҳо, мувозинаткунандаҳои сарборӣ, IP-ҳои шинокунанда ва reverse DNS
Ҳама чиз бо JSON тавассути HTTPS, бо усулҳо ва кодҳои ҳолати стандартии HTTP кор мекунад.
Токенҳои API
Токенҳо дар консол, дар қисми танзимоти лоиҳаи шумо сохта мешаванд.
| Имконот | Вазифа |
|---|---|
| Доираи лоиҳа | Токен танҳо барои як лоиҳа кор мекунад |
Префикси wk_ |
Токенҳои Wolkra-ро дар код ва сканерҳои асрор ба осонӣ шинохтан мумкин аст |
| Хондан ё хондану навиштан | Токенҳои танҳо барои хондан рӯйхат ва маълумот мегиранд, токенҳои хондану навиштан тағйир медиҳанд |
| Рӯйхати иҷозатдодаи IP | Ихтиёрӣ; дархостҳоро аз ҳар суроғаи дигар рад мекунад |
| Мӯҳлати амал | Ихтиёрӣ; токен пас аз санаи интихобкардаи шумо аз кор мемонад |
Ба ҳар скрипт ё хидмат токени алоҳида бо камтарин ҳуқуқи зарурӣ диҳед. Скрипти мониторинг танҳо ҳуқуқи хонданро талаб мекунад. Конвейери ҷойгиркунӣ (deployment pipeline) ба ҳуқуқи хондану навиштан, рӯйхати иҷозатдода барои runner-ҳои худ ва мӯҳлате, ки шумо нав мекунед, ниёз дорад.
Дархости аввал
Токенро ҳамчун bearer token фиристед:
curl -H "Authorization: Bearer wk_your_token_here" \
https://api.wolkra.com/v1/servers
Ҷавоб рӯйхати серверҳои лоиҳаи токенро нишон медиҳад. Ҳуҷҷати токенҳои API сохтани токен ва аввалин дархостҳоро қадам ба қадам шарҳ медиҳад.
Дастаҳо API-ро чӣ тавр истифода мебаранд
- Конвейерҳои ҷойгиркунӣ сервер месозанд, то бор шудани он интизор мешаванд, deploy иҷро мекунанд ва мувозинаткунандаи сарбориро нав мекунанд.
- Скриптҳои failover IP-и шинокунанда-ро вақте интиқол медиҳанд, ки сервери фаъол ҷавоб доданро бас мекунад.
- Бехатарии релизҳо: пеш аз ҳар релиз snapshot гирифта мешавад ва snapshot-ҳои кӯҳна баъдтар нест карда мешаванд.
- Муҳитҳои кӯтоҳмуддат барои як branch ё як санҷиш сервер меафрӯзанд ва баъди анҷом онҳоро нест мекунанд. Бо ҳисоби соатбайъ сервере, ки ду соат кор кардааст, ҳамагӣ ду соат арзиш дорад. Ниг. муҳитҳои таҳия.
- CI runner-ҳои чандир ҳангоми афзудани навбат сервер илова мекунанд ва ҳангоми холӣ шудани он серверҳоро хориҷ мекунанд.
- Панелҳои дохилӣ серверҳо ва графикҳоро бо токени танҳо барои хондан мехонанд.
Консол, Composer ва API дар якҷоягӣ
Консол, Composer ва API бо ҳамон як захираҳо кор мекунанд. Шумо метавонед стекро дар Composer кашед, онро татбиқ кунед ва баъд аз скриптҳо идора намоед. Тағйироти ҳар яки онҳо дар журнали фаъолияти лоиҳа сабт мешавад, бинобар ин даста мебинад, ки кӣ чӣ кор кардааст. Ниг. дастаҳо ва бехатарӣ.
Кор бо ҳар забони барномасозӣ
Азбаски API як REST-и оддӣ бо JSON аст, ба ягон китобхонаи махсус ниёз надоред. Скрипти shell бо curl ва jq, скрипти Python бо мизоҷи HTTP, хидмати Go ё вазифаи Node.js ҳама якхела кор мекунанд: дархостро бо bearer token мефиристед, ҷавоби JSON-ро мехонед ва коди ҳолатро месанҷед. Ҷавобҳо ҳар захираро бо ID, ном, нишонаҳо (labels) ва ҳолаташ тавсиф мекунанд, бинобар ин скрипт метавонад сервер созад, то ба кор даромадани он санҷад ва баъд ҳаҷм пайваст кунад ё онро ба мувозинаткунандаи сарборӣ илова намояд.
Одатҳои хуб барои скриптҳо:
- Захираҳоро ба ҷои ID-ҳои сахт навишташуда бо нишонаҳо ҷустуҷӯ кунед.
- Коди ҳолати HTTP-и ҳар дархостро санҷед ва ҳангоми хато корро қатъ кунед.
- Тағйири ҳолатро бо таваққуф байни дархостҳо санҷед, на дар даври бефосила.
- Барои корҳои гуногун токенҳои алоҳида нигоҳ доред, то бекор кардани яке дигаронро вайрон накунад.
Қайдҳои бехатарӣ
- Бо токенҳо мисли паролҳо муносибат кунед. Онҳоро дар менеҷери асрор ё анбори асрори CI-и худ нигоҳ доред, ҳеҷ гоҳ дар репозиторияи оммавӣ.
- Барои токенҳое, ки аз суроғаҳои собит кор мекунанд, рӯйхати иҷозатдодаи IP-ро истифода баред.
- Барои токенҳои пудратчиён ва корҳои муваққатӣ мӯҳлати амал муқаррар кунед.
- Ҳамин ки гумон кардед токен фош шудааст, онро дар консол бекор кунед.
Маҳдудиятҳое, ки бояд донед
- API роҳи автоматикунонии Wolkra аст. curl ё ҳар мизоҷи HTTP-ро истифода баред.
- Ҳар токен дар доираи як лоиҳа кор мекунад.
- Захираҳо дар Франкфурт, ягона макони мо дар айни замон, сохта мешаванд.
Саҳифаҳои марбут
Автоматикуниро оғоз кунед
Лоиҳа созед, токен гиред ва дар чанд дақиқа аввалин дархости худро фиристед. Дар Wolkra ҳисоб созед.
Саволҳои маъмул
API-и Wolkra дар куҷост?
REST API дар суроғаи https://api.wolkra.com/v1 ҷойгир аст. Он JSON-ро тавассути HTTPS истифода мебарад ва бо токени API дар сарлавҳаи Authorization тасдиқ карда мешавад.
Токенҳои API чӣ тавр кор мекунанд?
Токенҳоро дар консол месозед. Ҳар токен ба як лоиҳа тааллуқ дорад, бо wk_ оғоз мешавад ва ё танҳо барои хондан аст, ё барои хондану навиштан. Метавонед рӯйхати иҷозатдодаи IP ва санаи анҷоми мӯҳлатро илова кунед.
Бо API кадом абзорҳоро истифода бурдан мумкин аст?
Ҳар абзоре, ки бо HTTPS ва JSON кор мекунад, мувофиқ аст: аз curl дар скрипти shell то мизоҷи HTTP-и забони барномасозии дӯстдоштаи шумо.
Бо API чӣ кор кардан мумкин аст?
API захираҳоеро фаро мегирад, ки шумо дар консол идора мекунед: серверҳо, ҳаҷмҳо, шабакаҳо, firewall-ҳо, мувозинаткунандаҳои сарборӣ ва суроғаҳои IP.
Оё истифодаи API ройгон аст?
Бале. Барои дархостҳои API пул гирифта намешавад. Шумо танҳо барои захираҳое, ки месозед, пардохт мекунед ва ҳисоб соатбайъ аз тавозуни пешпардохт сурат мегирад.