Реєстрація

SMS шлюз. Підключення до API

Простий і зручний спосіб інтеграції з нашим сервісом.

  1. Загальні відомості
  2. Підключення
  3. Робота з API
  4. Клієнтська бібліотека на PHP
  5. Приклади використання
  6. Документація API

Загальні відомості

Якщо вам необхідно налаштувати автоматичні SMS-оповіщення з вашого Інтернет-магазину, 1С, CRM або іншого програмного забезпечення або ви використовуєте Mobizon як CRM - наше API допоможе вам вирішити ці завдання.

Для комунікації з сервером API використовується протокол HTTP з можливістю безпечних з'єднань SSL. Для передачі запитів використовуються методи GET і POST. Сервер може повертати відповідь в одному з форматів: XML або JSON на ваш вибір. Детальніше про те, як підключитися до API і виконувати запити, описано нижче.

Підключення до API

Для того щоб виконувати запити до API, необхідно увімкнути та налаштувати цю функцію в Панелі управління Mobizon:

  1. Відкрийте Налаштування API в Панелі управління:
    Додаток Налаштування API в Панелі управління
  2. Увімкніть опцію Ввімкнути доступ до API:
    Ввімкнути доступ до API Mobizon
  3. Вкажіть IP адреси, з яких будуть відбуватися запити до API.

Після ввімкнення доступу ви побачите свій Ключ API. Використовуйте цей ключ в вашому додатку для виконання запитів до 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.ua/service/

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

Обов'язкові параметри

Мінімальний запит до API містить назву модуля, методу і ключ API:

https://api.mobizon.ua/service/user/getownbalance?apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
где:

а після символу питання йдуть додаткові параметри, в даному випадку apiKey.
Важливо відзначити, що перед символом питання не повинно бути символу косої риски (слеш), такий запит буде вважатися неправильним:

https://api.mobizon.ua/service/user/getownbalance/?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>
где:

Коди відповідей API

Результат, що повертається, завжди містить поле code, яке містить числове значення, яке вказує на результат виконання запиту:

Клієнтська бібліотека на PHP

Ви можете використовувати офіційний клієнт MobizonApi на PHP. Приклади використання.

Крім цього, є можливість підключити цей модуль, використовуючи Composer.

Приклади роботи з Клієнтським модулем API на PHP

Якщо у Вас є власні робочі приклади використання, будемо раді розмістити їх у нас на сайті. Просто надішліть нам посилання або приклад коду за адресою support@mobizon.ua

Приклад використання GET запитів

Для відправки повідомлень з вашого додатки, якщо він не підтримує можливість реалізації POST запитів,              використовуйте GET запит наступного виду:

https://api.mobizon.ua/service/message/sendsmsmessage?recipient=NNNNNNNNNNN&from=PPPPPPP&text=Message+text+here%21&apiKey=KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK
где:

Реєструйтеся зараз і отримуйте БОНУС!

2.22 гривні на рахунок для тестування сервісу розсилки SMS-повідомлень та інших можливостей Mobizon.