Порядок подключения к SMS API

СОДЕРЖАНИЕ:

Подключение. Как включить доступ к API?

Для того чтобы выполнять запросы к API, необходимо авторизоваться на сайте и включить эту функцию в Панели управления.

1 Запустите приложение Настройки API в Панели управления.

Приложение Настройки API в Панели управления

2 Включите опцию Включить доступ к API.

Включить доступ к API Mobizon

После включения доступа вы увидите свой Ключ API. Используйте этот ключ в вашем приложении для выполнения запросов к API.

Ключ является секретным, не стоит его записывать или передавать кому-либо без необходимости, так как лицо, получившее ваш ключ, сможет производить любые операции с вашим аккаунтом.

Для повышения безопасности рекомендуем также указать список IP-адресов, с которых будут разрешены запросы к API с вашим ключом. В поле Список IP адресов для доступа к API перечислите IP-адреса ваших серверов. Адресов может быть несколько, в этом случае разделяйте их запятыми, например (192.12.34.56,23.45.67.89,123.123.123.123).

Обратите внимание!Если поле оставить пустым, работать с API можно будет с любого IP-адреса, но это небезопасно.

Вы можете сменить ключ API, нажав на кнопку «Обновить» рядом с ключом. В этом случае все приложения, использующие прежний ключ, не смогут получить доступ к API. Для возобновления доступа замените старый ключ на новый в настройках вашего ПО/сайта/клиента.

Описание API

Точка входа в API

Все запросы к API осуществляются по адресу: https://api.mobizon.com/service/

Обратите внимание!Вы можете отправлять запросы по протоколам HTTP и HTTPS по вашему выбору. Для безопасности коммуникации вашего ПО с API Mobizon мы рекомендуем все запросы делать посредством протокола HTTPS, но если ваше ПО не поддерживает возможность создания безопасных HTTP-запросов, то есть возможность делать запросы по обычному HTTP протоколу без шифрования, в таком случае адрес API для вас будет таким: http://api.mobizon.com/service/.
Все последующие упоминания https в документации и примерах можно считать равнозначными http.

Обязательные параметры

Минимальный запрос к API содержит название модуля, метода и ключ API:
https://api.mobizon.com/service/user/getownbalance?apiKey=1234567890abcdefghit1234567890abcdefghit
где:

а после символа вопроса идут дополнительные параметры, в данном случае apiKey.
Важно отметить, что перед символом вопроса не должно быть символа косой черты (слэш), такой запрос будет считаться неверным:
https://api.mobizon.com/service/user/getownbalance/?apiKey=1234567890abcdefghit1234567890abcdefghit

Опциональные параметры

output — формат возвращаемых данных

На данный момент поддерживается два формата ответа сервера API:

Пример запроса:
https://api.mobizon.com/service/user/getownbalance?output=json&api=v1

api — версия API

Актуальная версия API — v1, пример запроса:
https://api.mobizon.com/service/user/getownbalance?output=json&api=v1

другие параметры

Любые другие параметры, в том числе и параметры методов, могут быть переданы в качестве GET параметров или POST параметров. Следует учитывать максимальную длину GET строки, поэтому мы рекомендуем все запросы к API осуществлять посредством POST запросов.

Обратите внимание!Все значения передаваемых в API параметров должны быть в формате url-encoded. Как это сделать в конкретном языке программирования или системе, вы можете узнать в документации к соответствующему языку/системе.

Формат ответов сервера API

Обычно ответ сервера состоит из трех параметров: code, data и message:
{"code":0,"data":{"currency": 'KZT', "balance": 123.4567},"message":""}
где:

Коды ответов API

Клиентская библиотека на PHP

Вы можете использовать официальный клиент MobizonApi для PHP. Примеры использования.

Кроме этого, есть возможность подключить этот модуль, используя Composer.

Примеры работы с Клиентским модулем API на PHP

Пример использования GET запросов

Для отправки сообщений с вашего сайта или любого другого ПО используйте GET запрос следующего вида:

https://api.mobizon.com/service/message/sendsmsmessage?apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK&recipient=NNNNNNNNNNN&from=PPPPPPP&text=Текст сообщения

Где:
Зарегистрироваться
Регистрируйтесь сейчас и получайте БОНУС ➟
100 тенге на счет
для тестирования нашего сервиса!