Подключения

Общее

Swagger: https://api.radist.online/v2/docs#/Connections

Необходимые права доступа (scopes) для работы с API: connections

Подключение/connection - сущность, содержащая параметры для соединения с внешним сервисом (telegram/whatsapp/tinkoff/amocrm и т.п.)

Замечания

  • Через API нельзя удалить подключения. Для удаления необходимо обратиться в поддержку. Имейте в виду, что при удалении также удаляются связанные сущности. Например, при удалении терминала банка, будут удалены все выставленные счета. При удалении мессенджера, будут удалены все чаты и история переписки.

  • Редактирование параметров доступно не для всех типов подключений. Например, подключения AMOCRM/BITRIX управляются полностью на нашей стороне.

  • Чтобы подключение работало, оно должно быть в оплаченной подписке.

Примеры

Подключение Telegram

Подключение происходит в несколько шагов:

  1. Создание сессии для авторизации

  2. Авторизация

  3. Ввод пароля двухфакторной авторизации (если есть)

  4. Создание подключения

Подключение через сканирование QR-кода
  1. Создаём сессию авторизации https://api.radist.online/v2/docs#/Telegram/TelegramInitializeSession

  1. Отображаем пользователю QR-код для сканирования

  2. Периодически (например, раз в 5 секунд) опрашиваем статус сессии: https://api.radist.online/v2/docs#/Telegram/TelegramSendLoginRequest

  1. Если в ответ снова получили сессию со status=waiting_for_qr и qr-код изменился, показываем новый код пользователю.

  2. Если в ответ получили сессию со status=waiting_for_password, то показываем пользователю поле ввода пароля для 2FA. Этого шага может не быть, если 2FA отключена.

  1. После того, как получили сессию со status=authenticated, можно создавать подключение: https://api.radist.online/v2/docs#/Connections/ConnectionsCreateConnection

Подключение через код в чате Telegram
  1. Создаём сессию авторизации https://api.radist.online/v2/docs#/Telegram/TelegramInitializeSession

  1. Показываем пользователю поле для ввода кода

  2. Когда получили код, авторизуемся: https://api.radist.online/v2/docs#/Telegram/TelegramSendLoginRequest

  1. Если в ответ получили сессию со status=waiting_for_password, то показываем пользователю поле ввода пароля для 2FA. Этого шага может не быть, если 2FA отключена.

  1. После того, как получили сессию со status=authenticated, можно создавать подключение: https://api.radist.online/v2/docs#/Connections/ConnectionsCreateConnection

Повторная авторизация

В некоторых случаях может быть необходимо повторить авторизацию. Например, если в приложении Telegram принудительно завершили сессию, которую открыл наш сервис.

Это делается аналогично тому, как происходит первое подключение (см. примеры выше), только при создании сессии для авторизации нужно обязательно передать connection_id и после успешной авторизации не нужно создавать новое подключение.

Подключение Telegram Bot

Подключение

Необходимо создать подключение с типом telegram_bot, передав API ключ от бота: https://api.radist.online/v2/docs#/Connections/ConnectionsCreateItem

Подключение WhatsApp

Авторизация, подключение

Необходимо создать подключение с типом whatsapp: https://api.radist.online/v2/docs#/Connections/ConnectionsCreateItem

После этого необходимо отобразить пользователю QR-код, чтобы он отсканировал его в мобильном приложении WhatsApp. Сделать это можно двумя способами:

  1. Отдать пользователю ссылку из params->qr_url

  2. Также код можно получить этим методом: https://api.radist.online/v2/docs#/Connections/ConnectionsGetWhatsappInstanceStatus

Время жизни кода ограничено (около 30 сек). Возможно потребуется отсканировать его несколько раз.

Для переподключения достаточно запросить новый QR-код и отсканировать его.

Подключение MAX

Первое подключение
  1. Показываем пользователю поле для ввода кода

  2. Когда получили код, авторизуемся:

https://api.radist.online/v2/docs#/Max%20personal/Max%20personalSendLoginRequest

  1. После того, как получили сессию со status=authenticated, можно создавать подключение: https://api.radist.online/v2/docs#/Connections/ConnectionsCreateConnection

Подключение Одноклассников

Первое подключение

Необходимо создать подключение с типом odnoklassniki, передав API ключ от группы: https://api.radist.online/v2/docs#/Connections/ConnectionsCreateItem

Изменение API-ключа

Необходимость изменить API-ключ может возникнуть по разным причинам:

  • В настройках группы сбросили ключ

  • Ключ давно не использовался и стал неактивен

Для его обновления можно использовать метод: https://api.radist.online/v2/docs#/Connections/ConnectionsUpdateItem

Last updated

Was this helpful?