API для отправки sms: различия между версиями
DM (обсуждение | вклад) Нет описания правки |
Blin (обсуждение | вклад) Нет описания правки |
||
| (не показано 8 промежуточных версий 3 участников) | |||
| Строка 7: | Строка 7: | ||
== Общие сведения об API == | == Общие сведения об API == | ||
Данное API предназначено для владельцев сервисов рассылки SMS и позволяет подключить ваш сервис отправки SMS, если он отсутствует в [[Интеграция с SMS | списке доступных для интеграции]] и [[Интеграция с SMS#Отправка SMS-сообщений | отправлять SMS-сообщения]] из ПланФикса через него. | |||
Данное API позволяет подключить ваш сервис отправки SMS, если он отсутствует в [[Интеграция с SMS | списке доступных для интеграции]] и [[Интеграция с SMS#Отправка SMS-сообщений | отправлять SMS-сообщения]] из ПланФикса через него. | |||
После реализации интеграции вы можете обратиться в [https://planfix.ru/support/ | После реализации интеграции вы можете обратиться в нашу [https://planfix.ru/support/ Службу поддержки] по вопросу добавления вашего сервиса в список интеграций, доступных пользователям в интерфейсе ПланФикса. | ||
Взаимодействие производится по протоколу HTTPS. ПланФикс посылает запросы на указанный в настройках интеграции адрес сервиса. | Взаимодействие производится по протоколу HTTPS. ПланФикс посылает запросы на указанный в настройках интеграции адрес сервиса. | ||
| Строка 17: | Строка 15: | ||
== Подключение в интерфейсе ПланФикса == | == Подключение в интерфейсе ПланФикса == | ||
Для подключения и настройки интеграции перейдите в раздел '''Управление аккаунтом / Интеграции / Интеграция с сервисами отправки SMS''' | Для подключения и настройки интеграции перейдите в раздел '''Управление аккаунтом / Интеграции / Интеграция с сервисами отправки SMS'''. | ||
https://p.pfx.so/pf/1K/zKxQeK.png | |||
В открывшемся разделе выберите находящиеся в конце списка '''API ПланФикса (по логину и паролю)''' или '''API ПланФикса (по ключу доступа)''' - в зависимости от способа, каким будет производится авторизация запроса клиента в вашем сервисе. | В открывшемся разделе выберите находящиеся в конце списка '''API ПланФикса (по логину и паролю)''' или '''API ПланФикса (по ключу доступа)''' - в зависимости от способа, каким будет производится авторизация запроса клиента в вашем сервисе. | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/ZS/Aha5Jt.png | ||
| Строка 28: | Строка 31: | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/vO/Xi0SvG.png | ||
| Строка 79: | Строка 82: | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/Kt/bYlzjT.png | ||
| Строка 85: | Строка 89: | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/gH/DbJpnE.png | ||
ПланФикс при этом | ПланФикс при этом сделает вызов отправки смс. Полученный ответ или ошибка будут выведены на экран. | ||
https://p.pfx.so/pf/ | https://p.pfx.so/pf/Ci/RhVqTg.png | ||
== Перейти == | == Перейти == | ||
*[[Разработчикам: API]] | *[[Разработчикам: API]] | ||
Текущая версия от 14:11, 3 февраля 2022
Общие сведения об API
Данное API предназначено для владельцев сервисов рассылки SMS и позволяет подключить ваш сервис отправки SMS, если он отсутствует в списке доступных для интеграции и отправлять 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 |
Тестирование интеграции
Для теста работы интеграции зайдите в настройки интеграции, заполните все данные и нажмите на иконку колбы:
В открывшемся блоке введите номер телефона и текст сообщения и нажмите Протестировать
ПланФикс при этом сделает вызов отправки смс. Полученный ответ или ошибка будут выведены на экран.
