Обмен сообщениями

Обновлено 20 мая 2024

Обмен сообщениями со SaluteJazz API можно представить в виде схемы:

Обмен сообщениями включает следующие этапы:

1. Пользователь создает комнату в интерфейсе приложения. После чего, в соответствии с собственной логикой, приложение создает транспортный JWT-токен.

   При создании JWT-токена приложение шифрует его по алгоритму AES256 и подписывает его с помощью ключа SDK по алгоритму ECDSA.

   Полезная нагрузка транспортного токена должна включать обязательные поля:

   • Описание
   • Пример

   iat required	integer Время создания токена доступа.
   exp required	integer Время исчтечения срока действия токена доступа.
   jti required	string <uuid4> (([0-9a-fA-F-])36) Произвольный уникальный идентификатор токена доступа в формате uuid4. Используется для отслеживания токена в логах.
   sub required	string <uuid4> (([0-9a-fA-F-])36) Идентификатор пользователя в бэкенде приложения.
   sdkProjectId required	string <uuid4> (([0-9a-fA-F-])36) Идентификатор проекта SaluteJazz SDK в Studio. Вы можете найти идентификатор следующими способами: В адресной строке браузера, после переходта к проекту SaluteJazz SDK: https://developers.sber.ru/studio/workspaces/<идентификатор_пространтсва>/jazz/projects/<идентификатор_проекта>; В поле projectId, если декодируете ключ SDK. Ключ закодирован в Base64.

   {

   • "iat": 1516239022,
   • "exp": 1816239022,
   • "jti": "d3dea006-e200-442f-8f94-977d7bb27b3e",
   • "sub": "2b6574af-323e-4842-a8a5-943e99fb97de",
   • "sdkProjectId": "e26afe22-117a-4f59-9176-b5d6a04a7e2d"

   }

   iat required	integer Время создания токена доступа.
   exp required	integer Время исчтечения срока действия токена доступа.
   jti required	string <uuid4> (([0-9a-fA-F-])36) Произвольный уникальный идентификатор токена доступа в формате uuid4. Используется для отслеживания токена в логах.
   sub required	string <uuid4> (([0-9a-fA-F-])36) Идентификатор пользователя в бэкенде приложения.
   sdkProjectId required	string <uuid4> (([0-9a-fA-F-])36) Идентификатор проекта SaluteJazz SDK в Studio. Вы можете найти идентификатор следующими способами: В адресной строке браузера, после переходта к проекту SaluteJazz SDK: https://developers.sber.ru/studio/workspaces/<идентификатор_пространтсва>/jazz/projects/<идентификатор_проекта>; В поле projectId, если декодируете ключ SDK. Ключ закодирован в Base64.

   {

   • "iat": 1516239022,
   • "exp": 1816239022,
   • "jti": "d3dea006-e200-442f-8f94-977d7bb27b3e",
   • "sub": "2b6574af-323e-4842-a8a5-943e99fb97de",
   • "sdkProjectId": "e26afe22-117a-4f59-9176-b5d6a04a7e2d"

   }

2. Приложение обменивает транспортный токен на токен доступа:

   curl -L -X POST 'https://api.salutejazz.ru/v1/auth/login' \
   -H 'Accept: application/json' \
   -H 'Authorization: Bearer <транспортный_токен>'

   Адрес API изменился на https://api.salutejazz.ru/v1.

   Подробнее об изменении домена.

3. API возвращает токен доступа:

   • Пример
   • Описание

   token

   string Токен доступа для авторизации запросов к SaluteJazz API.

   {

   • "token": "string"

   }

   token

   string Токен доступа для авторизации запросов к SaluteJazz API.

   {

   • "token": "string"

   }

   Используйте токен доступа для авторизации последующих запросов к API.

4. Приложение передает запрос на создание комнаты. Токен доступа передается в заголовке Authorization.

5. API возвращает параметры созданной комнаты:

   • Пример
   • Описание

   roomId	string Идентификатор комнаты.
   roomPassword	string Пароль для доступа к комнате.
   roomUrl	string Веб-адрес, который содержит идентификатор комнаты и пароль для доступа к ней.
   	object or null Параметры вебинара. Содержит null, если в запросе не были переданы параметры вебинара.

   {

   • "roomId": "tool-5g1c28",
   • "roomPassword": "pd499ooo",
   • "roomUrl": "https://jazz.sberbank.ru/tool-5g1c28?psw=OAMGUUtdChkGEwFHFEkdCgkZHA",
   • "webinar": {

     • "viewerUrl": "http://salutejazz.ru/wg8hnr?type=webinar&role=VIEWER&psw=OEoIEUpXVEIbWg8HFUNDURRQEg",
     • "viewerPassword": "9jt8314r"

     }

   }

   roomId	string Идентификатор комнаты.
   roomPassword	string Пароль для доступа к комнате.
   roomUrl	string Веб-адрес, который содержит идентификатор комнаты и пароль для доступа к ней.
   	object or null Параметры вебинара. Содержит null, если в запросе не были переданы параметры вебинара.

   {

   • "roomId": "tool-5g1c28",
   • "roomPassword": "pd499ooo",
   • "roomUrl": "https://jazz.sberbank.ru/tool-5g1c28?psw=OAMGUUtdChkGEwFHFEkdCgkZHA",
   • "webinar": {

     • "viewerUrl": "http://salutejazz.ru/wg8hnr?type=webinar&role=VIEWER&psw=OEoIEUpXVEIbWg8HFUNDURRQEg",
     • "viewerPassword": "9jt8314r"

     }

   }

6. Приложение отображает параметры комнаты пользователю.

Смотрите также

• Описание API