Егер сізге интернет-дүкеніңізден, 1С, CRM немесе басқа бағдарламалық жасақтамаңыздан автоматты SMS-хабарламаларды баптау қажет болса немесе Mobizon-ды CRM ретінде пайдалансаңыз - біздің API сізге осы тапсырмаларды шешуге көмектеседі.
API серверімен байланыс үшін SSL қауіпсіз қосылымдарын пайдалану мүмкіндігі бар HTTP протоколы пайдаланылады. Сұрауларды жіберу үшін GET және POST әдістері қолданылады. Сервер жауапты XML немесе JSON форматтарының бірінде қайтара алады. API-ге қосылу және сұрауларды орындау туралы толығырақ төменде сипатталған.
API-ге қосылу
API-ге сұрауларды орындау үшін бұл функцияны Mobizon-ның Басқару панелінде қосып, баптау қажет:
API баптауларын Басқару панелінде ашыңыз:API-ге қол жеткізуді қосу опциясын қосыңыз:API-ге сұраулар жасалатын IP мекенжайларды көрсетіңіз.
Қолжетімділікті қосқаннан кейін сіздің API кілтіңіз көрінеді. API-ге сұраулар жасау үшін осы кілтті қолданыңыз.
Кілт құпия болып табылады, оны жазып алудың немесе қажетсіз біреуге берудің қажеті жоқ, өйткені кілтіңізді алған тұлға API арқылы сіздің аккаунтыңызбен кез келген операцияларды орындай алады.
Есептік жазбаңыздың қауіпсіздігін қамтамасыз ету үшін API-ге қол жеткізу рұқсат етілуі тиіс IP мекенжайлар тізімін көрсетуіңізді ұсынамыз. API-ге қол жеткізу үшін IP мекенжайлар тізімі өрісіне серверлеріңіздің IP мекенжайларын тізіп шығыңыз.
IP мекенжайлардың саны бірнеше болуы мүмкін, бұл жағдайда оларды үтірлермен бөліңіз, мысалы: 192.12.34.56,23.45.67.89,123.123.123.123 .
Егер өріс бос қалса, API-мен кез келген IP мекенжайдан жұмыс істеуге болады, бірақ бұл қауіпсіз емес.
API кілтін жаңарту батырмасын басу арқылы өзгерте аласыз. Бұл жағдайда бұрынғы кілтті пайдаланатын барлық қосымшалар API-ге қол жеткізе алмайды. Қол жеткізуді қайта бастау үшін қосымшаңыздың баптауларында ескі кілтті жаңасымен алмастырыңыз.
API-мен жұмыс
API-ге кіру нүктесі
API-ге барлық сұраулар мына мекенжай бойынша жүзеге асырылады: https://api.mobizon.kz/service/
Сіз HTTP немесе HTTPS арқылы сұрауларды жібере аласыз. Mobizon API-мен қосымшаңыздың байланыс қауіпсіздігін қамтамасыз ету үшін барлық сұрауларды HTTPS арқылы жасауды ұсынамыз, бірақ егер сіздің бағдарламалық жасақтамаңыз қауіпсіз HTTP сұрауларды жасау мүмкіндігін қолдамаса, онда сұрауларды шифрлаусыз әдеттегі HTTP протоколы арқылы жасауға болады, бұл жағдайда сіз үшін API мекенжайы: http://api.mobizon.kz/service/ болады.HTTPS барлық ескертулерін HTTP тең деп санауға болады.
Міндетті параметрлер
API-ге минималды сұрау модуль, әдіс және API кілтін қамтиды:
https://api.mobizon.kz/service/user/getownbalance?apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
мұнда:
user - API модулі,
getownbalance — API әдісі,
ал сұрақ белгісінен кейін қосымша параметрлер көрсетілген, бұл жағдайда apiKey .
Қосымша параметрлер
output — сервермен қайтарылатын жауап форматы.
json — жауап json жолы форматында қайтарылады (әдепкі бойынша)xml — жауап xml құжаты түрінде қайтарылады
https://api.mobizon.kz/service/user/getownbalance?output=json &api=v1&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK api — API нұсқасы.API нұсқасы — v1, бұл мән әдепкі бойынша қолданылады.
https://api.mobizon.kz/service/user/getownbalance?output=json&api=v1 &apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
Басқа параметрлер.
API параметрлерін беру кезіндегі барлық мәндер url-encoded форматында болуы тиіс. Белгілі бір бағдарламалау тілі немесе жүйеде оны қалай жасау керектігін тиісті тіл/жүйе құжаттамасынан біле аласыз.
API серверінің жауап форматы
Сервер жауабы мәліметтер форматының (XML немесе JSON) таңдалған түрінде объектіні қамтитын жол болып табылады, ол үш элементтен тұрады: code, data және message. JSON форматындағы жауап мысалы:
{
"code":0,
"data":{
"balance":"4043.0656",
"currency":"UAH"
},
"message":""
}
XML форматындағы жауап келесідей көрінеді:
<?xml version="1.0" encoding="UTF-8"?>
<root>
<code>0</code>
<data>
<balance>123.4567</balance>
<currency>UAH</currency>
</data>
<message></message>
</root>
мұнда:
code — API жауап коды, API жауап кодтарын құжаттамадан қараңыз,
data — API әдісімен орындалған мәліметтер форматы бойынша қайтарылған деректер, ал
қате коды жағдайында қате себептерін түсіндіретін деректердің мазмұны болуы мүмкін (мысалы, тексеру қатесі жағдайында қате өрістер тізімі және қателер сипаттамалары),
message — қате болған жағдайда қателіктің мәнін жалпы сипаттайтын күй мәтіні.
API жауап кодтары
Қайтарылған нәтиже әрқашан сұраудың орындалу нәтижесін көрсететін сандық мәнді қамтитын code өрісін қамтиды:
0 — жауап сәтті.100 — жауап қате емес және операцияның фондық орындауға жіберілгенін білдіреді. Бұл жағдайда деректер өрісі фондық операцияның ID, прогресс және күйін API taskqueue/getstatus сұрауы арқылы қадағалауға болады.
Кез келген басқа жауап коды — операцияны орындау кезінде қате. Қате кодтарын құжаттамадағы осы беттен қараңыз.
PHP тіліндегі клиенттік кітапхана
Сіз MobizonApi PHP тіліндегі ресми клиентін пайдалана аласыз. Қолдану мысалдары .
Бұдан басқа, осы модульді Composer арқылы қосу мүмкіндігі бар.
PHP тіліндегі API клиенттік модулімен жұмыс істеу мысалдары
Егер сізде өз жұмыс істеу мысалдарыңыз болса, біз оларды өз сайтымызға орналастыруға қуаныштымыз. Тек бізге сілтеме немесе код мысалын support@mobizon.ua мекенжайына жіберіңіз
GET сұрауларын пайдалану мысалы
Егер сіздің қосымшаңыз POST сұрауларды іске асыру мүмкіндігін қолдамаса, GET сұрауын келесі түрде пайдаланыңыз:
https://api.mobizon.kz/service/message/sendsmsmessage?recipient=NNNNNNNNNNN&from=PPPPPPP&text=Message+text+here%21&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
мұнда:
NNN...NNN - халықаралық форматтағы алушының телефон нөмірі (+ таңбасынсыз ),
мысалы,
380631392155.
PPP...PPP - жіберушінің қолтаңбасы (альфа ат). Қолтаңбаны көрсетпеуге болады, бұл жағдайда
жалпы жүйелік қолтаңба немесе әдепкі қолтаңба пайдаланылады (егер бар болса).
Message+text+here%21 - URL кодталған жол форматындағы SMS хабарламаңыздың мәтіні: Message text here! .KKK...KKK - Басқару панелінде алынуы тиіс API кілтіңіз.