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

Быстрый старт

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

Руководство по быстрому старту составлено в первую очередь для пользователей, взаимодействующих с API напрямую и выполняющих операции от имени своего торгового аккаунта, в связи с чем для авторизации запросов был выбран механизм JSON Web Token. Для разработчиков сторонних приложений, через которые их пользователи будут взаимодействовать с торговой системой, доступен сервис авторизации OAuth 2.0, позволяющий автоматизировать авторизацию запросов.

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

С помощью API пользователь может взаимодействовать с двумя контурами торговой системы:

  • Боевым, предоставляющим доступ к настоящим данным биржи, финансовым инструментам, позициям и сделкам;
  • Тестовым, предоставляющим доступ к игровой среде с симуляционными данными, в которой пользователь может протестировать запросы и основанные на них приложения.

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


Что дальше?