opened image

API - Қызметті жасау

Zomro платформасында қызметті тапсырыс беру процесінде бірнеше маңызды кезеңдерге назар аудару қажет: қызметті себетке қосу, промокодты белсендіру (бар болса) және қызметті сатып алу. Бұл қадамдар тапсырыс беру кезінде промокодтардың функционалын тиімді пайдалануға мүмкіндік береді. Тапсырыс беру үшін қызметтің белгілі параметрлерін беру қажет, олардың егжей-тегжейлері төменде көрсетілген.

Тапсырыс жасау процесі келесі кезеңдерден тұрады:

  • Қызметті себетке қосу
  • Промокодты белсендіру
  • Себеттен қызметті сатып алу

Дәл осындай сатып алу кезеңдерін пайдалану тапсырыс беру кезінде промокодты пайдалануға мүмкіндік береді.

Тапсырыс жасау үшін бізді қызықтыратын қызмет параметрлерін беру қажет. Қол жетімді параметрлерді қалай алуға болатыны мұнда сипатталған. 

 

Cloud VPS Zomro қызметін тапсырыс беру үшін сұраныс құрылымы:
 

URL: 

https://api.zomro.com/

Әдіс: POST

Сұраныс денесі (Form-data):
 

Параметр Мысал мәні Міндетті параметр Мәннің сипаттамасы
func v2.instances.order.param Иә Қызметті тапсырыс беру функциясы
auth 21fc199...c43f71 Жоқ Сессия токені. Бұл авторизацияның бір нұсқасы. Басқа нұсқалар туралы толығырақ мұнда сипатталған
out json Жоқ API-дан жауапты қандай форматта күту керек
sok ok Иә Операцияны растау
order_period -50 Иә CloudVPS қызметтері үшін күнделікті есептеу қолданылады. Қызметті сатып алу үшін мәнді пайдаланыңыз: -50, 1,  3,  6,  12.
-50 - күнделікті есептеу, 1 - 1 айға қызметті тапсырыс беру, 3 - 3 айға тапсырыс беру және т.б.
licence_agreement on Иә Пайдалану лицензиясымен келісу
pricelist 6740 Иә Тапсырыс беру қажет тарифтің ID-і. Тариф ID-ін v2.instances.order.pricelist функциясынан алуға болады. Қалай пайдалану керектігі мұнда сипатталған
order_count 1 Иә Бір сұраныста тапсырыс беруге болатын қызметтер саны
force_use_new_cart on Иә Қызметті жаңа billmanager себетіне қосу
instances_ssh_keys 490 Жоқ ОС орнатылғаннан кейін серверге қосылатын SSH кілтінің ID-і. use_ssh_key=off параметрі болса, берудің қажеті жоқ
password Mypassword1 Жоқ Серверге кіру паролі. Linux үшін - root пайдаланушысының паролі. Windows үшін - Administrator пайдаланушысының паролі. use_ssh_key=on параметрі болса, берудің қажеті жоқ.
Пароль кемінде 1 бас әріп, 1 цифрдан тұруы керек, минималды символ саны 8.  
servername MyServer Жоқ Сервердің жеке атауы
instances_os 18d0ee2e-4d57-4f40-9b56-03c1773b5831 Иә Орнатылатын операциялық жүйенің UID-і. Операциялық жүйенің UID-ін v2.instances.order.pricelist функциясынан алуға болады. Қалай пайдалану керектігі мұнда сипатталған
use_ssh_key off Жоқ SSH кілтін пайдалану немесе пайдаланбау. off немесе on мәндерін қабылдай алады.
addon_xxx

260

Жоқ Қызметтің қосымша параметрлері. RAM, CPU саны, диск көлемі, трафик көлемі, IPv4 немесе IPv6 түрі болуы мүмкін. Қол жетімді параметрлер тарифке байланысты. Қандай опциялар бар екенін мұнда мысалдан білуге болады
datacenter

13

Иә Деректер орталығының нөмірі. Қандай опциялар бар екенін мұнда мысалдан білуге болады
backups_schedule on Жоқ Резервтік көшірмелер жасау кестесін құру, резервтік көшірме жасау кезінде
backups_schedule_name MyBackup Иә, егер backups_schedule мәні пайдаланылса Резервтік көшірме жасау кестесінің атауы
backups_schedule_rotation_days 1,2,3,4,5,6,0 Иә, егер backups_schedule мәні пайдаланылса Қай күндері резервтік көшірмелер жасау. Аптаның басы жексенбіден басталады, ID - 0. Сәйкесінше, дүйсенбі 1 мәніне ие. Аптаның қалған күндері - сәйкес мәндер.
backups_schedule_rotation_time 04:20 Иә, егер backups_schedule мәні пайдаланылса Резервтік көшірмені жасау уақыты

 

 

Қызметті тапсырыс беру мысалы

Мысал ретінде, Linux Ubuntu 20.04 операциялық жүйесі бар Cloud Essential тарифін, тек IPv6 серверімен және root пайдаланушысының паролін пайдаланып алайық.

URL: 

https://api.zomro.com/

Әдіс: POST

 

Сұраныс денесі (Form-data):

Параметр Мән
func v2.instances.order.param
auth 21fc199...c43f71
out json
sok ok
order_period -50
licence_agreement on
pricelist

6740

order_count 1
password MyPassword1
servername MyServer-1
instances_os

479c96f1-ccc6-47a2-952c-c9e3bbdc8d07

use_ssh_key off

addon_6746

260

force_use_new_cart on
datacenter 13

 

Міне, консольдан орындауға болатын сұраныс мысалы:

curl --location 'https://api.zomro.com/' \
--form 'func="v2.instances.order.param"' \
--form 'auth="211a9ac6309a9f0c340bdebf"' \
--form 'out="json"' \
--form 'sok="ok"' \
--form 'order_period="-50"' \
--form 'licence_agreement="on"' \
--form 'use_ssh_key="off"' \
--form 'pricelist="6740"' \
--form 'servername="MyServer-1"' \
--form 'password="Mypassword1"' \
--form 'instances_os="479c96f1-ccc6-47a2-952c-c9e3bbdc8d07"' \
--form 'order_count="1"' \
--form 'addon_6746="260"' \
--form 'datacenter="13"' \
--form 'force_use_new_cart="on"'

 

Сұранысты орындағаннан кейін, бізге келесі деңгейде орналасқан деректер қажет:

doc

 

Сұранысты орындау нәтижесінде алынған мәндер:

...,

"lineitem.id": {
    "$": "1818"
},
...

 

 

Бұл "1818" мәні, себеттегі тапсырыс нөмірі, қызметті белсендіру үшін қажет. Оны әрі қарай пайдалану үшін есте сақтаймыз.

 

Бұл сұранысты орындағаннан кейін, себетте бар өнімді де көруге болады.


 

Келесі кезең - егер промокод болса, оны белсендіру. Бұл кезең міндетті емес, бірақ егер клиентте промокод болса, оны пайдалануға мүмкіндік болғаны жақсы.

URL: 

https://api.zomro.com/

Әдіс: POST

Сұраныс денесі (Form-data):

Параметр Мысал мәні Міндетті параметр Мәннің сипаттамасы
func cart Иә Себетпен жұмыс істеу функциясының атауы
auth 21fc199...c43f71 Жоқ Сессия токені. Бұл авторизацияның бір нұсқасы. Басқа нұсқалар туралы толығырақ мұнда сипатталған
out json Жоқ API-дан жауапты қандай форматта күту керек
sok ok Иә Операцияны растау
promocode PROMO_2024 Иә Пайдалануға жоспарланған промокод. 
clicked_button apply_promocode Иә Промокодты белсендіруді растау

 

Міне, консольдан орындауға болатын сұраныс мысалы:

curl --location 'https://api.zomro.com/' \
--form 'out="json"' \
--form 'auth="46ffb314c8d46ec1f2f1df16"' \
--form 'func="cart"' \
--form 'promocode="PROMO_2024"' \
--form 'sok="ok"' \
--form 'clicked_button="apply_promocode"'

 

Бұл сұранысты орындағаннан кейін, себетте промокодты белсендіру нәтижесін көруге болады:

 

 

Суретте промокод PROMO_2024 сәтті белсендіріледі. 
PS: Шын мәнінде, промокод PROMO_2024 сіздің жағдайыңызда жарамсыз, ол тек осы нұсқаулықты жазу үшін жасалған.

Келесі кезең - қызметті белсендіру.

Егер промокод 100% жеңілдік бермесе, қызметті жеке кабинеттен қосымша төлеу қажет. 

Егер промокод 100% қызмет құнын жабатын болса, API сұранысы келесідей болады:

 URL: 

https://api.zomro.com/

Әдіс: POST

Сұраныс денесі (Form-data):

Параметр Мысал мәні Міндетті параметр Мәннің сипаттамасы
func cartorder.create.confirm Иә Себетпен жұмыс істеу функциясы
auth 21fc199...c43f71 Жоқ Сессия токені. Бұл авторизацияның бір нұсқасы. Басқа нұсқалар туралы толығырақ мұнда сипатталған
out json Жоқ API-дан жауапты қандай форматта күту керек
sok ok Иә Операцияны растау
elid 1818 Иә Тапсырыс ID-і. Бұл мән қызметті себетке қосу кезінде алынды
paymethod_id 0 Иә Төлем әдісінің ID-і. 0 мәні стандартты болып табылады және жеке шоттан тапсырыс төлеу әдісіне сәйкес келеді

 

 

Міне, консольдан орындауға болатын сұраныс мысалы:

 

curl --location 'https://api.zomro.com/' \
--form 'out="json"' \
--form 'auth="cd63c7832f0ae5947c49ac06"' \
--form 'func="cartorder.create.confirm"' \
--form 'sok="ok"' \
--form 'elid="1818"' \
--form 'paymethod_id="0"'

 

 

Бұл сұранысты орындағаннан кейін, себетте бұл қызмет болмауы керек, CloudVPS қызметтерінің жалпы тізімінде біздің қызметіміз "Активация процесінде" статусымен көрінеді:

 

 

Қызметті белсендіру процесінде қосымша әрекеттер болмайды. Қызмет белсендірілгеннен кейін, бізге қызметтерді басқару үшін қол жетімді әрекеттер тізімі ашылады, мысалы: Бастау, Тоқтату, Жою, Өлшемін өзгерту және басқалар.
 

Сондай-ақ, API арқылы Cloud VPS өнімдерімен өзара әрекеттесу үшін пайдалы болуы мүмкін мақалаларды зерттеуді ұсынамыз: