Как использовать API управления идентификаторами
Версия 1.0.0
Авторские права © 2025 ПАО Московская Биржа
Как использовать API управления идентификаторами
1. Прежде, чем заполнить заявку
1.1. Как получить доступ к ЛКУ
1.2. Как получить токен доступа
1.3. Как получить orgId (ID организации)
1.4. Как проверить доступ участника к клирингу и торгам на требуемом рынке
1.5. Как получить сведения об организации
2. Как получить справочники и предзаполненные данные для заявок
2.1. Как получить список справочников для работы с заявлениями на идентификаторы
2.2. Как получить данные для предварительного заполнения значений всех типов заявок
2.3. Как проверить возможность подключения к КМП (MOEX Treasury)
2.4. Как получить справочник ТКС клиентов
2.5. Как получить справочник групп, зарегистрированных на указанном рынке
2.6. Как получить список IP-адресов в зависимости от типа подключения
2.7. Как получить справочник кратких кодов зарегистрированных клиентов
2.9. Как получить список значений действующих СКПЭП
2.10. Как получить данные по пакетам организации
2.11. Как получить список всех идентификаторов организации
2.12. При работе с идентификаторами Валютного рынка
2.13. При работе с идентификаторами Срочного рынка
3. Как заполнить и отправить заявку
3.2. Как подписать и отправить заявку
4.1. Как получить справочник возможных статусов заявок
4.2. Как отслеживать статус своих заявок
Получить доступ к ЛКУ
Получить токен доступа
Получить идентификатор организации orgId с помощью одного из методов Личного кабинета
Проверить доступ участника к клирингу и торгам на требуемом рынке
Получить сведения об организации
Получить справочники и предзаполненные данные для заявок
Заполнить заявку
Выбрать действующий СКПЭП из справочника
Подписать и отправить заявку
Отслеживать статус обработки заявки в техническом центре
API доступен для всех пользователей, которые получили доступ к Личному кабинету участника.
Подробнее о том, как получить доступ к ЛКУ, вы можете прочитать на странице по ссылке .
Инструкция по подключению API ЛКУ описана в файле WebAPI_connection_guide.pdf глава "Подключение API. Пошаговая инструкция".
Перед тем, как подать заявки на идентификаторы ФР, РД, РК, ВР, СР, ДР, пользователь должен получить токен авторизации.
Инструкция по получению токена описана в файле WebAPI_connection_guide.pdf глава "Получение токена доступа".
Для получения токена не требуется указывать параметр scope (запрашиваемые права доступа), необходимые значения будут переданы автоматически.
Требуемое значение client_id = PASSPORT_PUBLIC, могут быть использованы учетные данные пользователей, у которых уже есть доступ к ЛКУ.
Используйте полученный токен в последующих запросах для подтверждения прав доступа.
Для промышленной среды используются адреса https://passport.moex.com и https://apim.moex.com
Примеры URL ниже приведены для промышленной среды.
ID организации можно получить с помощью одного из методов Личного кабинета.
Запрос GET
https://apim.moex.com/lk/shared/permissions/scopes?locale=ru
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Используйте ID организации для в запросах к API управления логинами.
Запрос GET
-Header "Authorization: Bearer <ВашТокенАвторизации>"
https://apim.moex.com/lk/lku/1/login/management/external/organizations/status/access/markets (где 1 - ID организации)
Для набора рынков ФР, РД, РК используется специальный идентификатор market.id = 30.
На денежном рынке идентификатор может иметь доступ только к определённому виду операций, например, к М-Депозитам (mDepositAccessMode).
Соответствие названий рынков, их идентификаторов и параметров, содержащих признаки допуска, перечислены в таблице ниже.
name | market.id | Признак допуска к рынку |
---|---|---|
Срочный рынок | 3 | fortsAccessMode = 2 |
Фондовый рынок | 1 30 |
stockAccessMode=2 |
ФР, РД, РК | 30 | depositAccessMode=2 |
ФР, РД, РК | 30 | creditAccessMode=2 |
Валютный рынок | 2 | currencyAccessMode=2 |
Денежный рынок | 22 |
или
или
или
|
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/organizations (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/logins (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/orders/prefill/{marketId} (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/cmp/check/info/{orderFormType} (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
КМП
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/certificates (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Справочники - [Certificates]
Справочник ТКС (торгово-клиринговых счетов) клиентов нужен для заполнения списка выбранных ТКС в заявлениях на идентификаторы.
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/orders/trd/accids/{marketId} (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Справочники - [Orders/trd/accids/{marketId}]
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/groups/{marketId} (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/ip (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Справочник кратких кодов зарегистрированных клиентов нужен для заполнения заявлений на присвоение и изменение идентификаторов спонсируемого доступа.
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/orders/client/codes/{marketId} (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/vpts (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Список значений действующих СКПЭП нужен для заполнения криптоимени в заявлении на идентификаторы.
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/certificates (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Данные по пакетам организации нужны для возможности включения идентификатора(-ов) в пакет услуг
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/organizations/packages/limits (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Метод отвечает за получение для просмотра всех идентификаторов на ФР, РД, РК, ВР, СР, ДР на собственном ПО с использованием API Биржи.
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/organizations/agents (где 1 - ID организации)
-Header"Authorization: Bearer <ВашТокенАвторизации>"
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/instruments (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/clearing/broker/attributes (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Справочники - [Clearing broker attributes]
Список разделов нужен для указания ограничений полномочий идентификаторов по разделам Срочного рынка.
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/chapter (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Справочники - [Chapter]
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/orders/{orderFormType} (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
API по взаимодействию с заявками
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/orders/send (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"
Заявки - [Send {orderFormType}/{orderId}]
Справочник возможных значений для параметра orderState из метода /lk/lku/{orgId}/login/management/external/orders
Запрос GET
https://apim.moex.com/lk/lku/1/login/management/external/dictionaries/orders (где 1 - ID организации)
-H "Authorization: Bearer <ВашТокенАвторизации>"
Заявки - [Orders] — метод отвечает за получение списка всех заявок на присвоение, изменение и аннулирование ИТД/ИСД, зарегистрированного на любом из рынков ФР, РД, РК, ВР, СР, ДР (без ИСД), созданных на собственном ПО с использованием API Биржи.
Метод POST
https://apim.moex.com/lk/lku/1/login/management/external/orders (где 1 - ID организации)
-Header "Authorization: Bearer <ВашТокенАвторизации>"