API для отправки sms — различия между версиями

Версия 11:37, 6 февраля 2020

Содержание

1 Общие сведения об API
2 Подключение в интерфейсе ПланФикса
3 Формат запроса на отправку смс при авторизации по логину и паролю
4 Формат запроса на отправку смс при авторизации по ключу доступа
5 Перейти

Общие сведения об API

API позволяет подключить к ПланФикс любой ваш собственный сервис для отправки SMS

Интеграция ПланФикса и Сервисов отправки SMS позволяет решить бизнес-задачу отправки SMS клиентам по наступлению определенных событий. Данное API позволяет подключить ваш сервис отправки смс, если он отсутствует в списке доступных для интеграции и посылать SMS-сообщения из ПланФикса через него - [общий принцип работы с отправкой смс в ПланФиксе] При этом после реализации интеграции вы можете обратиться в [службу поддержки] по вопросу добавления вашего сервиса в список.

Взаимодействие производится по протоколу HTTPS. ПланФикс посылает запросы на указанный в настройках интеграции адрес сервиса.

Подключение в интерфейсе ПланФикса

Для подключения и настройки интеграции перейдите в раздел Управление аккаунтом / Интеграции / Интеграция с сервисами отправки SMS

В открывшемся разделе выберите находящиеся в конце списка API ПланФикса (по логину и паролю) или API ПланФикса (по ключу доступа) - в зависимости от способа, каким будет производится авторизация запроса клиента в вашем сервисе.

Откроется окно настроек интеграции.

В нём надо будет указать адрес, куда ПланФикс будет слать запросы, логин и пароль клиента и имя отправителя SMS (для случая авторизации по ключу доступа - API Key вместо логина и пароля)

Формат запроса на отправку смс при авторизации по логину и паролю

Запрос передаётся методом POST в application/x-www-form-urlencoded формате на адрес указанный в параметрах интеграции.

Параметры запроса:

Имя	Описание	Тип/формат данных
login	логин, указанный в параметрах интеграции	string
password	пароль, указанный в параметрах интеграции	string
from	имя отправителя	string
to	номер телефона, на который отправляется sms	string
text	текст сообщения	string

Формат запроса на отправку смс при авторизации по ключу доступа

Запрос передаётся методом POST в application/x-www-form-urlencoded формате на адрес указанный в параметрах интеграции.

Параметры запроса:

Имя	Описание	Тип/формат данных
key	API Key, указанный в параметрах интеграции	string
from	имя отправителя	string
to	номер телефона, на который отправляется sms	string
text	текст сообщения	string

Перейти

Разработчикам: API

@@ Строка 5: / Строка 5: @@
 |description=API для отправки sms
 }}
 == Общие сведения об API ==
@@ Строка 15: / Строка 14: @@
 Взаимодействие производится по протоколу HTTPS. ПланФикс посылает запросы на указанный в настройках интеграции адрес сервиса.
 == Подключение в интерфейсе ПланФикса ==
@@ Строка 20: / Строка 20: @@
 В открывшемся разделе выберите находящиеся в конце списка '''API ПланФикса (по логину и паролю)''' или '''API ПланФикса (по ключу доступа)''' - в зависимости от способа, каким будет производится авторизация запроса клиента в вашем сервисе.
 https://pic.planfix.ru/pf/tC/lJTfYi.jpg
 Откроется окно настроек интеграции.
 https://pic.planfix.ru/pf/UJ/9BuerN.jpg
 В нём надо будет указать адрес, куда ПланФикс будет слать запросы, логин и пароль клиента и имя отправителя SMS (для случая авторизации по ключу доступа - API Key вместо логина и пароля)
 == Формат запроса на отправку смс при авторизации по логину и паролю ==
@@ Строка 48: / Строка 53: @@
 |-
 |}
 == Формат запроса на отправку смс при авторизации по ключу доступа ==