BILLmanager API интерфейсімен қалай жұмыс істеу керек

API - командалар мен функциялар жиынтығы арқылы кез келген қолданбаны басқаруға мүмкіндік беретін бағдарламалық интерфейс. Мысалы, Yandex Music API бар, оның арқасында сайтта музыкалық шығармаларды тыңдай аласыз. Біз өз жұмысымызда BILLmanager биллингін қолданамыз.

Оның өзінің API интерфейсі бар, оның көмегімен сіз серверлерді икемді тарифтер бойынша масштабтай аласыз, төлемдер, шотыңыздан дебеттер туралы ақпаратты ала аласыз. Кез келген API әзірлеушісі әдетте бағдарламалық құрал интерфейсін орнату және конфигурациялау үшін веб-сайтта егжей-тегжейлі құжаттамаға ие.

Дегенмен, BILLmanager API құжаттамасын түсіну қиын. Егер сіз API кәсіпқойы болғыңыз келсе, құжаттаманы зерттеуді бастаудың уақыты келді. Егер сіз үшін ең бастысы тапсырманы орындау және қысқа мерзімде нәтиже алу болса, төменде сипаттайтын нұсқауларды пайдалану жеткілікті.

Параметрлер тізімі

BILLmanager API интерфейсімен жұмыс істеу кезінде туындайтын бірінші сұрақтардың бірі - параметрлер тізімін қайдан алуға болады? BILLmanager бағдарламасымен жұмыс істеуге арналған барлық параметрлерді әзірлеуші құжаттамасынан табуға болады. Жұмыс параметрлерінің толық тізімін мына сілтеме арқылы табуға болады.

VDS тізімін қалай алуға болады

VDS тізімін алу үшін келесі URL мекенжайына сұрау салу қажет:

 https://bill.pq.hosting/billmgr?func=vds&authinfo=username:password&out=JSONdata

Сұраныстағы параметрлер:

• authinfo — есепшоттағы авторизация деректері;
• func — есепшотта орындалатын функция;
• out - деректерді шығару пішімі, xml, json және JSONdata қолдайды.

Барлық сұрауларда жеке деректеріңізді пайдалану қажет, сондықтан username:password пайдаланушы аты мен құпия сөзге өзгертіңіз, содан кейін GET сұрауын орындаңыз, мысалы, CURL арқылы.

VDS қалай тапсырыс беруге болады

VDS тапсырыс беру үшін келесі URL мекенжайына сұрау салу керек:

https://bill.pq.hosting/billmgr?func=vds.order.param&authinfo=username:password&addon_10=6&addon_11=256&addon_12=500 &addon_13=1&addon_14=28&addon_15=0&addon_28=1&addon_7=5000&addon_9=5&autoprolong=1 &ostempl=ISPsystem%5F%5FCentOS%2D7%2Damd64&period=1&pricelist=6&skipbasket=on&domain=vds.test&sok=ok

Сұраныстағы параметрлер:

• authinfo — есепшоттағы авторизация деректері;
• func — есепшотта орындалатын функция;
• addon_X — тапсырысқа қосымша (міндетті емес), мысалы, басқару панеліне немесе IPv6 мекенжайларына тапсырыс беру үшін;
• autoprolong - серверді автоматты түрде кеңейтуді қосу немесе өшіру опциясы;
• ostempl - тапсырыс беруге арналған ОЖ үлгісі;
• period — тапсырыс кезеңі, айлар саны көрсетіледі, 1, 3, 6, 12 қолдау көрсетіледі;
• pricelist — тарифтік жоспар идентификаторы;
• skipbasket — қызметке автоматты түрде тапсырыс беру үшін себетті тексеру кезеңін өткізіп жіберуге арналған жалауша;
• domain — сервердің домен атауы (міндетті емес);
• sok – сұранысты растау.

Сервер параметрлерін өзгерту

Виртуалды сервер параметрлерін өзгертуге арналған API:

https://bill.pq.hosting/billmgr?func=vds.edit&authinfo=username:password&addon_11=512&elid=958&domain=company.com&sok=ok

Арнайы сервер параметрлерін өзгерту үшін:

 https://bill.pq.hosting/billmgr?func=dedic.edit&authinfo=username:password&addon_26=10&addon_26=10&addon_28=5000&elid=1065&sok=ok

Сұраныстағы параметрлер:

• authinfo — есепшоттағы авторизация деректері;
• func — есепшотта орындалатын функция;
• elid — қызмет көрсету коды;
• addon_X — өзгертулер үшін қосымша (міндетті емес), мысалы, IP мекенжайларының санын өзгерту үшін;
• domain — домендік атау (міндетті емес);
• sok – сұранысты растау.

API арқылы қызметке тапсырыс беру немесе өзгерту кезінде тарифтік жоспар толықтырулары addon_ параметрі арқылы жіберіледі, ол addon_5=10 мәнін қабылдайды, мұндағы 5 - қосымша коды, 10 - мән.

API сұрауларын жасау кезінде сіз «желі» қойындысында браузер консолін пайдалана аласыз, серверге тапсырыс бергенде, сол параметрлерді API сұраулары арқылы жіберуге болады; Жоғарыдағы тізім функциялар мен параметрлердің ішінара тізімі бар API сұрауларының мысалдарын сипаттайды.

Циклдермен жұмыс

VDS жою, жад немесе процессор өзектерін қосу қажет болса, мұны BILLmanager API қолданбасынсыз жасауға болады. Дегенмен, 10, 100 VDS тапсырысы немесе сервер параметрлерінің жаппай өзгеруі жағдайында бұл процесс бірнеше сағатқа созылуы мүмкін. Мұндай жағдайларда ілмектер жиі қолданылады:

 #!/bin/bash seq 1 32 | while read line; do curl -s -k "https://bill.pq.hosting/billmgr?func=vds.order.param&authinfo=username:password&addon_10=6&addon_11=256&addon_12=500 &addon_13=1&addon_14=28&addon_15=0&addon_28=1&addon_7=5000&addon_9=5&autoprolong=1 &ostempl=ISPsystem%5F%5FCentOS%2D7%2Damd64&period=1&pricelist=6&skipbasket=on&domain=vds.test$line&sok=ok" done

Мысал серверге тапсырыс беру үшін API сұрауын пайдаланады. Серверге тапсырыс беру параметрлері циклдарды пайдаланбай бір серверге тапсырыс беруге ұқсас.

Әзірлеушіден BILLmanager API-мен жұмыс істеу туралы толық құжаттама осы жерде берілген.