Авторизация
Данный запрос необходимо выполнять первым после установки WebSocket-соединения и повторять периодически для обновления используемого Access токена.
Запрос осуществляет авторизацию установленного WebSocket-соединения, в рамках которого будут выполняться все последующие запросы на управление заявками. Каждое новое соединение с интерфейсом /cws
авторизуется отдельно.
Авторизация не бессрочна — запросы, выполняемые в рамках авторизованного соединения, считаются авторизованными в пределах срока действия Access токена (30 минут с момента создания). При истечении данного срока потребуется повторить запрос с новым токеном для продолжения работы.
Запрос
Авторизованный доступ к WebSocket API предоставляется только в рамках того WebSocket-соединения, в котором запрос был выполнен. Для каждого нового WebSocket-соединения авторизация должна производиться отдельно.
Для авторизации соединения и всех последующих команд, выполняемых в рам ках него, выполните запрос с актуальным Access токеном в качестве значения параметра token
.
- Тело запроса
- Схема
{
"opcode": "authorize",
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"token": "eyJhbGciOiJ..."
}
Параметры тела запроса
authorize
— Авторизация WebSocket-соединенияcreate:market
— Создание рыночной заявкиcreate:limit
— Создание лимитной заявкиcreate:stop
— Создание стоп-заявкиcreate:stopLimit
— Создание стоп-лимитной заявкиupdate:market
— Изменение рыночной заявкиupdate:limit
— Изменение лимитной заявкиupdate:stop
— Изменение стоп-заявкиupdate:stopLimit
— Изменение стоп-лимитной заявкиdelete:market
— Снятие рыночной заявкиdelete:limit
— Снятие лимитной заявкиdelete:stop
— Снятие стоп-заявкиdelete:stopLimit
— Снятие стоп-лимитной заявки
Пример: authorize
Код выполняемой операции:
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: eyJhbGciOiJ...
Access Токен для авторизации запроса
Ответы
В зависимости от результатов обработки полученного запроса сервер вернёт в WebSocket-соединение сообщение с соответствующим кодом ответа.
- 200
- 400
- 401
Сообщение об успешной обработке запроса
- Тело ответа
- Схема
{
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"httpCode": 200,
"message": "The connection has been initialized."
}
Параметры тела ответа
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: 200
Код возвращаемого сообщения
Пример: The connection has been initialized.
Текстовое представление возвращаемого сообщения
Не удалось обработать запрос. Проверьте корректность переданного сообщения и повторите попытку.
- Тело ответа
- Схема
{
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"httpCode": 400,
"message": "Invalid or unsupported quantity"
}
Параметры тела ответа
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: 400
Код возвращаемого сообщения
Пример: Invalid or unsupported quantity
Текстовое представление возвращаемого сообщения
Не удалось авторизовать запрос — Access Токен не указан в теле запроса, срок его действия истёк или он относится к другому контуру системы
- Тело ответа
- Схема
{
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"httpCode": 401,
"message": "Invalid JWT token!"
}
Параметры тела ответа
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: 401
Код возвращаемого сообщения
Пример: Invalid JWT token!
Текстовое представление возвращаемого сообщения