SberJazz API

Скачать OpenAPI-спецификацию:Скачать

Краткое описание эндпоинтов и поддерживаемых HTTP-методов.

Для доступа к API вам понадобится два токена — транспортный токен и токен доступа. Транспортный токен генерирует фронтенд вашего приложения на основе данных полученных от бэкенда. Используйте его для получения токена доступа к API.

Подробнее об авторизации запросов читайте в одноименном разделе.

Authentication

Транспортный токен

Передается в заголовке Authorization и используется для получения токена доступа в ответ на запрос POST /api/v1/auth/login. Транспортный токен генерируется на клиенте.

Security Scheme Type	HTTP
HTTP Authorization Scheme	Bearer

Токен доступа

Передается в заголовке Authorization и используется для авторизации запросов к API.

Security Scheme Type	HTTP
HTTP Authorization Scheme	Bearer

Авторизация

Получить токен доступа

post/v1/auth/login

Возвращает токен доступа для авторизации запросов к API в обмен на транспортный токен.

Авторизация

Транспортный токен

Ответы

Пример ответа

200

Content type

application/json

{"token": "string"
}

Работа с комнатами

Создать комнату

post/v1/room/create

Возвращает объект с параметрами комнаты: идентификатором, веб-адресом и паролем.

Авторизация

Токен доступа

Схема запроса: application/json

roomTitle

string

Произвольное название комнаты

Ответы

Пример запроса

Payload

Content type

application/json

{"roomTitle": "Мастер-класс"
}

Пример ответа

200

Content type

application/json

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

Изменить название комнаты

post/v1/room/{roomId}/settings/update

Изменяет название комнаты.

Авторизация

Токен доступа

PATH-ПАРАМЕТРЫ

roomId

required

string

Идентификатор комнаты

Схема запроса: application/json

roomTitle

string

Произвольное название комнаты

Ответы

Пример запроса

Payload

Content type

application/json

{"roomTitle": "Мастер-класс"
}

Выключить комнату

post/v1/room/{roomId}/disable

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

Авторизация

Токен доступа

PATH-ПАРАМЕТРЫ

roomId

required

string

Идентификатор комнаты

Схема запроса: application/json

object (DisableRoomRequestDto)

Запрос на выключение комнаты

Ответы

Пример запроса

Payload

Content type

application/json

{ }