Управление идентификаторами -«КМП»
Версия 1.0.0
Авторские права © 2025 ПАО Московская Биржа
Содержание
Метод POST /lk/lk/lku/{orgId}/login/management/external/cmp/check/info/{orderFormType}
Документ содержит инструкцию по проверке возможности пользователей подключаться к системе корпоративного маркетплейса Московской биржи (MOEX Treasury). Также приведен пример ответа на запрос, включающий сообщение об ошибке.
Описание кодов ответов HTTP
| Статус код | Тип | Сообщение | Описание |
|---|---|---|---|
| 2xx - Успешные | |||
| 200 | ОК | Успешно | Операция выполнена успешно. Например, GET: Запрошенный ресурс был найден и передан в теле ответа. Указывает на успешное выполнение запроса. Это означает, что сервер получил и обработал запрос корректно, и клиент может ожидать получения запрошенных данных или выполнения действия. |
| 201 | CREATED | Запрос успешно выполнен и в результате был создан ресурс. | При создании ресурса в ответе может быть включен заголовок Location, который указывает URL нового ресурса. Это позволяет клиенту сразу узнать, где он может получить доступ к созданному ресурсу. В теле ответа содержится информация о созданном ресурсе, такая как его уникальный идентификатор. |
| 204 | NO CONTENT | Нет содержимого для ответа на запрос. | Сервер успешно обработал запрос, но в ответе были переданы только заголовки без тела сообщения. Клиент не должен обновлять содержимое документа, но может применить к нему полученные метаданные. |
| 4xx - Клиентские ошибки | |||
| 400 | BAD REQUEST | Некорректный запрос. Убедитесь, что адрес указан верно и попробуйте еще раз. | Не были переданы обязательные входные параметры или во входных параметрах были переданы не валидные данные. |
| 401 | UNAUTHORIZED | Ошибка авторизации. Для доступа к запрашиваемому ресурсу требуется аутентификация. | Если данные для аутентификации не переданы или недействительны, а также при неуспешной валидации токена. |
| 5xx - Серверные ошибки | |||
| 500 | INTERNAL SERVER ERROR | Внутренняя ошибка сервера. Подождите несколько минут и попробуйте снова. | Ошибка на стороне сервера. Сервер обнаружил неожиданное условие, которое он не знает как обработать. |
| 502 | Bad Gateway | Плохой, ошибочный шлюз. | Сервер, действующий как шлюз или прокси-сервер, столкнулся с проблемой при попытке установить связь с вышестоящим сервером. Это ошибка на стороне сервера, и клиент обычно не может устранить ее напрямую. |
Выходные параметры при ошибке
| Параметр | Тип данных JSON | Обязательность | Описание параметра |
|---|---|---|---|
| statuscode | integer | да | Код состояния HTTP |
| exception | string | да | Сообщение об ошибке |
| response | string | да | Описание ошибки |
{
"statuscode": "integer",
"exception ": "string",
"response": "string"
}
Проверка возможности подключения к КМП (Системе Корпоративного Маркетплейса).
| Параметр | Принадлежность | Тип данных | Обязательность | Наименование | Комментарий |
|---|---|---|---|---|---|
| orgId | path | string | Да | Идентификатор организации | Значение orgId из ответа метода /lk/shared/permissions/scopes |
| orderFormType | path | string/ integer | Да | Тип формы документа (заявки) | orderFormType может принимать следующие значения: OrderAssigningSmLogin = 0 (Присвоение идентификаторов на ФР) OrderChangeSmLogin = 1 (Изменение идентификаторов на ФР) OrderAssigningSmLoginIsd = 2 (Присвоение ИСД на ФР) OrderChangeSmLoginIsd = 3 (Изменение ИСД на ФР) OrderCancelSmLogin = 4 (Аннулирование идентификаторов / ИСД ФР) OrderAssigningFxLogin = 5 (Присвоение идентификаторов на ВР) OrderChangeFxLogin = 6 (Изменение идентификаторов на ВР) |
OrderAssigningFxLoginIsd = 7 (Присвоение ИСД ВР) OrderChangeFxLoginIsd = 8 (Изменение ИСД ВР) OrderCancelFxLogin = 9 (Аннулирование идентификаторов ВР) OrderPasswordResetOnline = 10 (Сбросить пароль для идентификаторов) OrderAssigningFoLogin = 11 (Присвоение идентификатора СР) OrderChangeFoLogin = 12 (Изменение идентификатора СР) OrderAssigningFoLoginIsd = 13 (Присвоение ИСД СР) OrderChangeFoLoginIsd = 14 (Изменение ИСД СР) OrderCancelFoLogin = 15 (Аннулирование идентификатора СР) OrderAssigningMoLogin = 16 (Присвоение ИСД ДР) OrderChangeMoLogin = 17 (Изменение ИСД ДР) OrderCancelMoLogin = 18 (Аннулирование идентификатора ДР) |
|||||
| ClientRequestId | header | - | Нет | Идентификатор клиентского запроса | Идентификатор запроса, который используется для логирования на стороне биржи. Этот атрибут может генерироваться системой автоматически, но в таком случае нам будет тяжело отследить выполненный запрос при разборе инцидентов. Рекомендуем пользователям заполнять атрибут собственным значением. |
| Bearer | header | JWT токен | Да | Токен авторизации | Токен доступа к API Московской Биржи. Параметр access_token из ответа на POST запрос https://sso.moex.com/auth/realms/SSO/protocol/openidconnect/token |
| data | body | object | Да | Данные для проверки возможности подключения к КМП | |
| .idpUser | body | string | Нет | Moex passport | |
| .surName | body | string | Нет | Фамилия | |
| .firstName | body | string | Нет | Имя | |
| .patronymicName | body | string | Нет | Отчество | |
| .token | body | string | Нет | Токен | |
| .certificate | body | string | Нет | СКПЭП (Сертификат ключа проверки электронной подписи) | Значение certificate из ответа метода /lk/lku/{orgId}/login/management/external/dictionaries/certificates |
| .market | body | integer | Нет | Рынок | Может принимать следующие значения: id = 30 (name = ФР, РД, РК) id = 1 (name = Фондовый рынок) id = 2 (name = Валютный рынок) id = 3 (name = Срочный рынок) id = 22 (name = Денежный рынок) |
{
"data": {
"surName": "Иванов",
"firstName": "Иван",
"patronymicName": "",
"idpUser": "1234@mail.ru",
"token": "SAS1960",
"certificate":
"INN=000000000000,OGRN=1111111111111,SNILS=22222222222,T=Специалист,CN=Сотрудник
69,OU=Департамент ИТ,O=ООО Торговая Компания,L=Москва,ST=77
г.Москва,C=RU"
}
}
| Параметр | Тип данных | Обязательность | Наименование | Может быть null | Пример значения |
|---|---|---|---|---|---|
| data | object | нет | Получение проверки возможности подключения к КМП | нет | |
| code | string | нет | Код | да | "code”: "step1" |
| message | string | нет | Сообщение | да | "message": "Токен не найден" |
| isError | boolean | нет | Ошибка | нет | "isError": "false" |
{
"data": {
"code": "error11",
"message": "Токен не найден",
"isError": true
}
}