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

СОДЕРЖАНИЕ:

Подключение

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

ШАГ 1 — Авторизируемся в системе -> заходим в Настройки API

Порядок подключения к SMS Api - Шаг 1

Далее включите опцию “Включить доступ к API”.

ШАГ 2 — Настройки API -> включить доступ к API

Порядок подключения к SMS Api - Шаг 2

После включения доступа Вы увидите Ваш «Ключ API». Используйте этот ключ в Вашем приложении для выполнения запросов к 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/

Обратите внимание!Для безопасности коммуникации вашего ПО с 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

Код 0 соответствует успешному ответу.
Код 100 не является ошибкой и означает, что операция была отправлена в фоновое выполнение. В этом случае поле data содержит ID фоновой операции, процесс и окончание которой можно отследить при помощи Taskqueue::GetStatus.
Все остальные коды ответа так или иначе указывают на ошибку во время выполнения операции.
Просмотреть коды ошибок можно на этой странице.

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

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

Также Вы можете подключить этот модуль используя Composer.

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

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

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

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

Где: