Перейти к основному содержимому

Рекомендации, спецификации, интеграции

📢 Уважаемые клиенты! 📢

Делимся с Вами новостями о последних изменениях!

✏ В этом дайджесте:

  • Описание механизма социального рейтинга
  • Обновление рекомендаций и ограничений по работе с системой
  • Обновление списка примеров использования API
  • Скачиваемые спецификации OpenAPI и AsyncAPI
  • Новое поле в рисках и портфельных сводках
  • Исправления ошибок

🔽 Подробнее — под катом! 🔽

Социальный рейтинг​

Некоторое время назад мы обновили статью о Защитной блокировке, расширив её до полноценного описания Защитных механизмов системы. Поскольку изменение было опубликовано без отдельного анонса, фиксируем его в списке изменений ретроспективно — для сохранения истории изменений и для тех, кто ещё не знаком с этой статьёй.

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

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

Рекомендуем ознакомиться с обновлённой статьёй для более предсказуемой работы с системой.

Затронутые страницы

Рекомендации и ограничения​

Как и с предыдущим примером, некоторое время назад мы обновили статью о принципах Добросовестного использования, заменив её новой статьёй о Рекомендациях и ограничениях при работе с системой. Ранее мы уже упоминали об этом обновлении в канале в MAX, однако не фиксировали его отдельно в списке изменений. Так что да, это ещё одна ретроспективная публикация изменений — для сохранения истории изменений и для пользователей, ещё не знакомых с обновлённой документацией.

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

Как и Защитные механизмы системы, данные ограничения направлены на защиту системы от избыточной нагрузки, возникающей из-за определённых паттернов использования API. При этом это разные механизмы, использующие отдельные условия и критерии ограничения доступа.

Помимо публикации новой статьи были обновлены страницы HTTP API, WebSocket API и GraphQL API — в них добавлена информация об ограничениях, характерных для каждого интерфейса. Также была опубликована статья Сравнение интерфейсов, помогающая выбрать наиболее подходящий интерфейс для конкретных задач.

Настоятельно рекомендуем ознакомиться с обновлёнными статьями, особенно если вы активно используете API в автоматизированных сценариях.

Затронутые страницы

SDK и инструменты​

SDK? Да, SDK.

Вместе с прочими изменениями в этом обновлении мы переработали статью Примеры и инструменты, ставшую теперь SDK и инструменты.

Обновление затронуло как структуру, так и содержание статьи. Мы расширили список примеров реальных приложений и библиотек, работающих с нашим API, а также добавили в список ссылки на официальный SDK от наших разработчиков.

Рекомендуем заглянуть в обновлённый раздел всем, кто уже пишет или только планирует разработку решений на базе АЛОР API — особенно тем, кто ищет готовые инструменты и хочет сэкономить время на интеграцию.

Затронутые страницы

Скачиваемые спецификации​

С этим обновлением в документации появилась возможность скачать файлы спецификаций в соответствующих интерфейсам стандартах — OpenAPI для HTTP API и AsyncAPI для WebSocket API.

Скачиваемые спецификации можно использовать для автоматической генерации клиентов, валидации схем и других сценариев машинной обработки API. Файлы обновляются вместе с основной документацией, за счёт чего сохраняется их актуальность.

Скачать файлы можно по соответствующим кнопкам на страницах описания интерфейсов HTTP API и WebSocket API.

Для GraphQL доступ к схемам и размещение ссылок на них осталось неизменным, но описание процесса их получения и авторизации запросов переехало в новую статью Доступ к схеме.

Надеемся, новые спецификации будут полезны в разработке приложений!

Затронутые страницы

Новое поле derivativesDebt​

Для срочных и ЕДП-портфелей в API появилось новое поле derivativesDebt (dd в Slim-формате ответа), позволяющее отслеживать текущую задолженность по обеспечению срочного рынка.

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

Для срочного рынка значение рассчитывается на основе полей moneyFree и varMargin:

  • если сумма значений больше либо равна 0, derivativesDebt возвращается как 0;
  • если сумма значений меньше 0, в derivativesDebt передаётся отрицательное значение этой суммы.

Для ЕДП-портфелей дополнительно учитывается лимит Т0 фондового рынка. В случаях, когда данные ЕДП недоступны или не были подтверждены актуальным лимитированием, значение derivativesDebt может возвращаться как null.

Для остальных типов портфелей значение поля всегда равно null.

Влияет на запросы​

HTTP

WebSocket-подписки

Исправления ошибок​

С последнего обновления документации было обнаружено несколько неточностей в описании API. Часть из них была выявлена благодаря сообщениям пользователей.

В рамках исправлений:

  • уточнены описания полей portfolioEvaluation и portfolioLiquidationValue в запросах сводной информации и рисков — ранее их определения были перепутаны и были менее информативны;
  • исправлено имя поля скорректированной маржи в Slim-формате ответа для запросов получения сводной информации о портфеле — поле скорректированной маржи возвращается как cm, а не mgc, как было указано ранее в документации;
  • в схемах WebSocket-запросов на изменение и удаление заявок был неправильно указан параметр orderId, из-за чего на деле в схеме дважды отображался параметр side.

Отдельно благодарим причастных к обнаружению этих ошибок! С вашей помощью документация становится лучше!

Влияет на запросы​

HTTP

WebSocket-подписки

WebSocket-команды

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

Если у вас есть идеи по дальнейшему развитию системы, можете отправить их нам через портал Обратной связи.

Спасибо, что помогаете нам делать систему лучше!