Версия от 12:56, 31 июля 2025

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

кфк

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

выфвфывфы

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

вфыввфыв

@@ Строка 10: / Строка 10: @@
 https://vendor.era-platform.ru/integration/ws_sandbox.html
+Данный инструмент позволяет наглядно протестировать все процессы работы с WebSocket в рамках платформы.
 = Авторизация и начало работы =
-бла бла бла
+[[Файл:Параметры авторизации в WebSocket.png|мини]]
+=== Параметры авторизации ===
+Для подключения к вебсоткету необходимо указать следующие параметры:
+* Адрес сервера
+** При использовании HTTPS  необходимо использовать схему WSS: wss://192.168.98.10
+** При использовании HTTP, необходимо использовать схему WS: ws://192.168.98.10
+** При использовании портов, отличных от стандартных (443 и 80), необходимо указывать их через двоеточие: ws://192.168.98.10:8080
+* Тип авторизации
+** Учетная запись пользователя домена
+** Авторизационный токен канала интеграции
+* Домен*
+* Логин*
+* Пароль*
+<nowiki>*</nowiki>только при использовании авторизации через учетную запись.
+=== Старт соединения ===
+Для начала работы, необходимо произвести несколько базовых шагов:
+# Подключиться к WebSocket
+# Настроить соединение - передать сообщение setup, в котором перечислить требуемые [https://vendor.era-platform.ru/docs/era/latest/api/websocket/user/index.html#_%D0%B4%D0%BE%D1%81%D1%82%D1%83%D0%BF%D0%BD%D1%8B%D0%B5_user_api capabilities]
+# Произвести авторизацию - передать авторизационные данные
+Для быстрого выполнения этих шагов, в песочнице предусмотрены кнопки в блоке параметров авторизации:
+* '''Connect''' - подключение
+* '''Setup''' - настройка соединения
+* '''Login''' - авторизация
+Каждая из этих кнопок отправляет шаблонное сообщение, позволяющее без ручного составления JSON пройти каждый из этих шагов.<blockquote>При ручном тестировании не следует медлить, так как вебсокет автоматически закроется через несколько секунд, если не была произведена авторизация.</blockquote>Кнопка '''Info''' позволяет получить информацию о текущем подключении:
+* Сайт
+* Домен
+* Идентификаторы пользователя, сессии и подключения
+* Текущие возможности Websocket (запрошенные через сообщение setup)
+* Текущая дата и время
+* Роли
+* и т.д.
+Кнопка '''Close''' позволяет закрыть текущее соединение.
 = Работа с данными классов =