API управления идентификаторами. С чего начать

Версия 1.0.0

Авторские права © 2025 ПАО Московская Биржа

Содержание

Назначение API

Как использовать API

Swagger

Поддержка и обратная связь

Разделы технической документации

Назначение API

Программный интерфейс «Управление идентификаторами», основанный на методологии REST, предоставляет участникам торгов/клиринга и кандидатам в участники возможности по управлению идентификаторами технического доступа.

Участникам:

• на просмотр, создание, изменение, аннулирование идентификаторов технического доступа на фондовом рынке, рынке депозитов, рынке кредитов, валютном рынке и рынке драгоценных металлов, срочном рынке, а также денежном рынке;

• на просмотр, создание, изменение, аннулирование идентификаторов спонсируемого доступа на фондовом рынке, валютном рынке и рынке драгоценных металлов, а также срочном рынке.

Кандидатам:

• на создание идентификаторов технического доступа на фондовом рынке, рынке депозитов, рынке кредитов, валютном рынке и рынке драгоценных металлов, срочном рынке, а также денежном рынке.

Список сокращений

Как использовать API

Как использовать API управления идентификаторами

Swagger

1. Регистрация в тестовой системе

   Перейдите на сайт https://passport-test.moex.com и зарегистрируйте тестовый аккаунт.

2. Вход на портал API

После регистрации откройте https://apim-portal.beta.moex.com/ и нажмите кнопку "Sign in" в правом верхнем углу интерфейса.

3. Авторизация через Passport

   На странице входа выберите красную кнопку "Passport" (OAuth-авторизация), введите логин и пароль от созданного в п.1 аккаунта и нажмите "Вход".

   После успешной авторизации вы будете перенаправлены на главную страницу портала.

4. Выбор API для тестирования

   В меню портала перейдите в раздел "Catalog", найдите API "Управление идентификаторами" (GUID: e217bd91-8149-402c-97bd-918149902c98) либо пройдите по прямой ссылке для быстрого доступа.

Важная информация для пользователей:

На текущий момент тестовый полигон API ЛКУ (Личного кабинета пользователя) недоступен.

Уважаемые пользователи, вы можете:

• Просматривать методы API через интерфейс Swagger;
• Скачивать спецификации OpenAPI;
• Использовать спецификацию при создании ваших приложений, реализующих управление идентификаторами;
• Изучать структуру запросов и ответов;
• Валидировать запросы и ответы.

Мы рекомендуем использовать Swagger для подготовки запросов и анализа документации, однако отправка данных и получение ответов в тестовой среде невозможны.

Для уточнения деталей и получения помощи обращайтесь в службу технической поддержки.

Поддержка и обратная связь

Служба технической поддержки

help@moex.com 

+7 (495) 733-9507 

Обратную связь и пожелания по развитию продукта можно направлять на адрес

loginportal@moex.com

Разделы технической документации

1. Как использовать API управления идентификаторами
   Содержание:

   Как использовать API управления идентификаторами

   1. Прежде, чем заполнить заявку

   1.1. Как получить токен доступа

   1.2. Как получить orgId

   1.3. Как проверить доступ участника к клирингу и торгам на требуемом рынке

   1.4.  Как получить сведения об организации

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

   2.1. Как получить список справочников для работы с заявлениями на идентификаторы

   2.2.  Как получить данные для предварительного заполнения значений всех типов заявок

   2.3. Как проверить возможность подключения к КМП (MOEX Treasury)

   2.4. Как получить справочник ТКС клиентов

   2.5. Как получить справочник групп, зарегистрированных на указанном рынке

   2.6. Как получить список IP-адресов в зависимости от типа подключения

   2.7. Как получить справочник кратких кодов зарегистрированных клиентов

   2.8. Как получить список ВПТС

   2.9. Как получить список значений действующих СКПЭП

   2.10. Как получить данные по пакетам организации

   2.11. Как получить список всех идентификаторов организации

   2.12. При работе с идентификаторами Валютного рынка

   2.13. При работе с идентификаторами Срочного рынка

   3. Как заполнить и отправить заявку

   3.1. Как заполнить заявку на различные действия с идентификаторами, проверить её и получить на подпись

   3.2. Как подписать и отправить заявку

   4. После заполнения заявки

   4.1. Как получить справочник возможных статусов заявок

   4.2. Как отслеживать статус своих заявок

2. Управление идентификаторами - "КМП"
   Документ содержит инструкцию по проверке возможности пользователей подключаться к системе корпоративного маркетплейса Московской биржи (MOEX Treasury). Также приведен пример ответа на запрос, включающий сообщение об ошибке.
   Содержание:

   Введение

   Описание кодов ответов

   Тело ответа при ошибке

   Пример запроса с ошибкой

   Метод POST /lk/lk/lku/{orgId}/login/management/external/cmp/check/info/{orderFormType}

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

   Выходные параметры

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

3. Управление идентификаторами - "Справочники"
   Документ представляет собой подробное руководство для получения справочных данных при работе с идентификаторами на бирже. Руководство содержит описание методов API, которые позволяют получать справочные данные, например группы пользователей, статусы заявок, списки ТКС клиентов, IP-адреса и другое. Эти методы упрощают процесс заполнения заявлений на идентификаторы.
   Содержание:

   Введение

   История изменений

   Описание кодов ответов

   1. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/logins

   actionTypes

   orderTypes

   icdbAgentTypes

   clearingAgentTypes

   restrOnTradeModes

   restrictionUseAll

   connectionTypeBillings

   terminalTypes

   connectionTypes

   orderConnectionTypes

   vptsConnectionTypes

   interfaceLanguage

   authorities

   tradeModes

   markets

   instrumentRestrictions

   instrumentTypes

   fortsConnectionTypes

   ukUtForms

   loginLevels

   streams

   tsAstsPlazas

   directConnection

   2. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/groups/{marketId}

   3. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/orders

   4. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/orders/prefill/{marketId}

   5. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/status

   6. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/ip

   7. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/orders/client/codes/{marketId}

   8. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/orders/trd/accids/{marketId}

   9. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/certificates

   10. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/instruments

   11. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/clearing/broker/attributes

   12. Метод GET /lk/lku/{orgId}/login/management/external/dictionaries/chapter

   13. Метод POST /lk/lku/{orgId}/login/management/external/dictionaries/vpts

4. Управление идентификаторами - "Заявки"
   Документ описывает методы управления идентификаторами для получения заявок на присвоение, изменение и аннулирование ИТД/ИСД на рынках Московской биржи, таких как Фондовый рынок (ФР), Рынок депозитов (РД), Рынок кредитов (РК), Валютный рынок (ВР), Срочный рынок (СР) и Денежный рынок (ДР). Основные методы включают получение списка всех заявок, получение детализированной информации по одной заявке, создание новой заявки и ее отправку на рассмотрение. Для каждого метода подробно описаны все атрибуты и параметры, такие как тип данных, обязательность и примеры использования. Также приведены схемы ответов на запросы, включая примеры данных, которые могут быть получены в результате вызова соответствующих методов.
   Содержание:

   Введение

   Описание кодов ответов

   Тело ответа при ошибке

   Пример запроса с ошибкой

   Метод POST /lk/lku/{orgId}/login/management/external/orders

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

   Выходные параметры

   Метод GET  /lk/lku/{orgId}/login/management/external/orders/{orderId}

   Выходные параметры

   Метод POST  /lk/lku/{orgId}/login/management/external/orders/{orderFormType}

   Метод POST  /lk/lku/{orgId}/login/management/external/orders/send/{orderFormType}/{orderId}

   Выходные параметры

5. Как заполнить заявку на различные действия с идентификаторами методом POST
   Руководство описывает порядок создания документов (заявок) на различные действия с идентификаторами методом POST /lk/lku/{orgId}/login/management/external/orders/{orderFormType}. В документе перечислены доступные типы заявок, обязательные и необязательные параметры для каждого типа. Поясняется, как заполнять параметры.
   Содержание:

   Введение

   Headers

   Path-параметры

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

   Обязательность входных параметров для разных типов заявок

   Тип заявки OrderAssigningSmLogin – Присвоение идентификаторов на ФР.

   Тип заявки OrderChangeSmLogin – Изменение идентификаторов на ФР.

   Тип заявки OrderAssigningSmLoginIsd – Присвоение ИСД на ФР.

   Тип заявки OrderChangeSmLoginIsd – Изменение ИСД на ФР.

   Тип заявки OrderCancelSmLogin – Аннулирование идентификаторов / ИСД ФР.

   Тип заявки OrderAssigningFxLogin – Присвоение идентификаторов на ВР.

   Тип заявки OrderChangeFxLogin – Изменение идентификаторов на ВР.

   Тип заявки OrderAssigningFxLoginIsd – Присвоение ИСД ВР.

   Тип заявки OrderChangeFxLoginIsd – Изменение ИСД ВР.

   Тип заявки OrderCancelFxLogin – Аннулирование идентификаторов ВР.

   Тип заявки OrderPasswordResetOnline – Сбросить пароль для идентификаторов.

   Тип заявки OrderAssigningFoLogin – Присвоение идентификатора СР.

   Тип заявки OrderChangeFoLogin – Изменение идентификатора СР

   Тип заявки OrderAssigningFoLoginIsd – Присвоение ИСД СР.

   Тип заявки OrderChangeFoLoginIsd – Изменение ИСД СР.

   Тип заявки OrderCancelFoLogin – Аннулирование идентификатора СР.

   Тип заявки OrderAssigningMoLogin – Присвоение идентификаторов ДР.

   Тип заявки OrderChangeMoLogin – Изменение идентификаторов ДР.

   Тип заявки OrderCancelMoLogin – Аннулирование идентификатора ДР.

   Как заполнять заявки. Входные параметры

   Примеры запросов в зависимости от типа заявок

   Тип заявки «Присвоение идентификаторов на ФР»

   Тип заявки «Изменение идентификаторов на ФР»

   Тип заявки «Присвоение ИСД на ФР»

   Тип заявки «Изменение ИСД на ФР»

   Тип заявки «Аннулирование идентификаторов / ИСД ФР»

   Тип заявки «Присвоение идентификаторов на ВР»

   Тип заявки «Изменение идентификаторов на ВР»

   Тип заявки «Присвоение ИСД ВР»

   Тип заявки «Изменение ИСД ВР»

   Тип заявки «Аннулирование идентификаторов ВР»

   Тип заявки «Сбросить пароль для идентификаторов»

   Тип заявки «Присвоение идентификатора СР»

   Тип заявки «Изменение идентификатора СР»

   Тип заявки «Присвоение ИСД СР»

   Тип заявки «Изменение ИСД СР»

   Тип заявки «Аннулирование идентификатора СР»

   Тип заявки «Присвоение ИСД ДР»

   Тип заявки «Изменение ИСД ДР»

   Тип заявки «Аннулирование идентификатора ДР»

   Выходные параметры

   Алгоритм работы

6. Управление идентификаторами - "Организации"
   Документ содержит описание входных и выходных параметров методов API Управления идентификаторами из раздела "Организации"  /lk/lku/{orgId}/login/management/external/organizations.
   Содержание:

   1. Введение

   2. Описание кодов ответов HTTP

   3. Метод GET /lk/lku/{orgId}/login/management/external/organizations

   Входные параметры

   Выходные параметры

   4. Метод POST /lk/lku/{orgId}/login/management/external/organizations/agents

   5. Метод GET /lk/lku/{orgId}/login/management/external/organizations/agents/{agentId}

   6. Метод POST /lk/lku/{orgId}/login/management/external/organizations/agents/export

   7. Метод GET /lk/lku/{orgId}/login/management/external/organizations/status/access/markets

   8. Метод GET /lk/lku/{orgId}/login/management/external/organizations/orders-linked/{loginId}

   9. Метод GET /lk/lku/{orgId}/login/management/external/organizations/agents/{agentId}/export

   10. Метод GET /lk/lku/{orgId}/login/management/external/organizations/packages/limits

7. Дополнительная информация
   Документ содержит инструкции по заполнению различных типов заявок методом POST API управления идентификаторами Московской биржи. Он включает подробные рекомендации по параметрам для каждого типа заявки, такие как присвоение идентификаторов, изменение полномочий и аннулирование. Даны описания к параметрам, которые подробнее раскрывают их назначение и особенности заполнения. Это помогает пользователям правильно подготовить и подать заявку, минимизируя вероятность отказа или задержки в обработке.
   Содержание:

   Введение

   Список сокращений

   Подсказки для заполнения заявок в методе POST  /lk/lku/{orgId}/login/management/external/orders/{orderFormType}

   Для заявки на Присвоение ИТД ФР, РД, РК (OrderAssigningSmLogin)

   Для заявки на Изменение ИТД ФР, РД, РК (OrderChangeSmLogin)

   Для заявки на Присвоение ИСД ФР, РД, РК (OrderAssigningSmLoginIsd)

   Для заявки на Изменение ИСД ФР, РД, РК (OrderChangeSmLoginIsd)

   Для заявки на Аннулирование идентификаторов ФР, РД, РК (OrderCancelSmLogin)

   Для заявки на Присвоение ИТД ВР

   Для заявки на Изменение ИТД ВР (OrderChangeFxLogin)

   Для заявки на Присвоение ИСД ВР (OrderAssigningFxLoginIsd)

   Для заявки на Изменение ИСД ВР (OrderChangeFxLoginIsd)

   Для заявки на Аннулирование идентификаторов ВР (OrderCancelFxLogin)

   Для заявки на Присвоение ИТД CР (OrderAssigningFoLogin)

   Для заявки на Изменение ИТД CР (OrderChangeFoLogin)

   Для заявки на Присвоение ИСД CР (OrderAssigningFoLoginIsd)

   Для заявки на Изменение ИСД CР (OrderChangeFoLoginIsd)

   Для заявки на Присвоение идентификаторов ДР (OrderAssigningMoLogin)

   Для заявки на Изменение идентификаторов ДР (OrderChangeMoLogin)

   Для заявки на Аннулирование идентификаторов ДР (OrderCancelMoLogin)

   Как заполнять типы и способы подключений в зависимости от рынка

   Присвоение ИТД/ИСД (OrderAssigningSmLogin/ OrderAssigningSmLoginIsd)

   Изменение ИТД/ИСД (OrderChangeSmLogin/ OrderChangeSmLoginIsd)