GATUM
By Sempico Solutions

Как настроить для клиента подключение по REST API протоколу?

GATUM — полнофункциональная платформа, которая может подключаться к клиентам с помощью различных подключений. После того, как новый клиент зарегистрировался на платформе или вы создали его в админ панели, то он может начать отправлять тестовые СМС. Клиент имеет возможность отправлять СМС из своей веб панели, а также через SMPP протокол или API (самый быстрый способ интеграции), или REST API (более профессиональный метод интеграции).

Сейчас мы расскажем, как настроить отправку через REST API. Мы используем сервис Postman для подключения. Перейдите по этой ссылке https://documenter.getpostman.com/view/3547620/SWEB1aY9.

Для авторизации в нашем REST API используется стандарт OAuth2.

Для этого, в сервисе Postman, после того, как вы перешли по ссылке выше, вам необходимо:

  1. На странице Autorization должен стоять верный адрес. После restapi введите свой домен, в этом случае — gatum.io.
authorization-in-postman-to-get-a-permanent-token-to-send-sms-to-rest-api
  1. В блоке Body введите логин и пароль клиента от веб доступа в кабинет на платформе.
postman-authorization-data
  1. Нажмите на синюю кнопку Send. 
sending-a-request-for-authorization

Система возвращает вам временный токен. Скопируйте его.

temporary-token
  1. Перейдите на страницу Access token.
  2. Проверьте верность адреса.
checking-a-domain-to-get-a-permanent-token
  1. В блоке Body вставьте временный токен, который вы скопировали ранее.
copy-temporal-token
  1. Нажмите на синюю кнопку Send.
send-temporal-token

Система возвращает вам постоянный токен.

get-permanent-token

После получения постоянного токена вы можете использовать все API внизу (отправка одиночной СМС, массовая рассылка, создание базы данных номеров). Посмотреть пример использования этих API вы можете в видео на нашем YouTube канале.

api-for-working-with-sms-mailings

Отчеты по отправленным СМС будут храниться на вкладке SMS full data. Используя фильтрацию вверху, вы можете узнать, какие именно SMS были отправлены по протоколу REST API.

search-for-messages-on-the-platform-sent-by-rest-api

Очередь отчетов по СМС отправленным через REST API вы можете отслеживать во вкладке RESTAPI DLRs.

Если у клиента будет несколько серверов, с которых он будет отправлять трафик по этому протоколу, то создайте для него соответствующее количество токенов и добавьте соответствующее количество IP адресов в блоке REST API IP. Это делается для того, чтобы отчеты о доставках не терялись (возможна ситуация что, если клиент подключиться с разных своих серверов, используя один и тот же логин, то СМС может прийти с одного сервера, а Отчет о доставке уйдет  на другой сервер — ведь логин тот же самый). Поэтому рекомендуется контролировать этот момент.

check-conforming-amount-of-tokens

Вот так легко вы можете настраивать подключение клиента по REST API протоколу.

Share the Post: