WebSocket песочница

Общая информация

Для облегчения разработки интеграций, отладки и тестирования, в состав платформы включена websocket-песочница.

Это мини-приложение позволяет быстро и удобно подключаться к платформе по WebSocket, производить запросы, осуществлять подписки и визуализировать результаты.

Песочница доступна на каждой инсталляции, по следующему адресу:

https://[era_platform_fqdn]/integration/ws_sandbox.html

Например, она доступна на ресурсе Vendor:

https://vendor.era-platform.ru/integration/ws_sandbox.html

Данный инструмент позволяет наглядно протестировать все процессы работы с WebSocket в рамках платформы.

Песочница вертикально разделена на 3 зоны:

• Слева находится управление запросами и шаблонами, а также настройки авторизации.
• По центру выводятся табличные данные классов, если производится их чтение с отображением.
• Справа отображается история сообщений в WebSocket, а также поле для свободной отправки сообщений.

Авторизация и начало работы

Параметры авторизации

Для подключения к вебсоткету необходимо указать следующие параметры:

• Адрес сервера
  • При использовании HTTPS необходимо использовать схему WSS: wss://192.168.98.10
  • При использовании HTTP, необходимо использовать схему WS: ws://192.168.98.10
  • При использовании портов, отличных от стандартных (443 и 80), необходимо указывать их через двоеточие: ws://192.168.98.10:8080
• Тип авторизации
  • Учетная запись пользователя домена
  • Авторизационный токен канала интеграции
• Домен*
• Логин*
• Пароль*

*только при использовании авторизации через учетную запись.

Тип авторизации определяет используемый WebSocket API:

• User-API
• Token-API

Старт соединения

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

1. Подключиться к WebSocket
2. Настроить соединение - передать сообщение setup, в котором перечислить требуемые capabilities
3. Произвести авторизацию - передать авторизационные данные

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

• Connect - подключение
• Setup - настройка соединения
• Login - авторизация

Каждая из этих кнопок отправляет шаблонное сообщение, позволяющее без ручного составления JSON пройти каждый из этих шагов.

При ручном тестировании не следует медлить, так как вебсокет автоматически закроется через несколько секунд, если не была произведена авторизация.

Кнопка Info позволяет получить информацию о текущем подключении:

• Сайт
• Домен
• Идентификаторы пользователя, сессии и подключения
• Текущие возможности Websocket (запрошенные через сообщение setup)
• Текущая дата и время
• Роли
• и т.д.

Кнопка Close позволяет закрыть текущее соединение.

Работа с данными классов

Песочница позволяет удобно производить запросы к классам платформы и продуктового слоя. Доступны следующие операции:

• Чтение
• Подписка на изменение
• Визуализация данных
• Создание
• Замена по идентификатору
• Обновление по идентификатору
• Удаление по идентификатору

В качестве примера, в песочнице реализованы три шаблона.

Шаблон My status позволяет прочитать статус текущего пользователя, подписаться на его изменение и при необходимости изменить его.

Шаблон Call management позволяет просмотреть текущие (активные) звонки, а также управлять ими.

Шаблон My archive calls читает данные звонков текущего пользователя, и может использоваться как пример для работы с фильтрами, сортировкой и интервалами (для классов со storageMode=history).

Вызов сервисов

выфвфывфы

Ручная отправка запросов

вфыввфыв