REST

Для работы c использованием REST можно использовать API или Swagger T-Invest API. C помощью него вы можете тестировать методы T-Invest API.

API

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

Формирование запроса

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

2. Далее в блоке Authorization ввести токен доступа и выбрать окружение: биржа или песочница.

3. В блоке Body корректно ввести параметры запроса.

4. Нажать кнопку Отправить запрос.

   

Обработка ответа

1. После отправки запроса в блоке Ответ отобразится ответ сервера.

2. Успешный ответ будет иметь статус 200.

3. Данные в успешном ответе можно раскрыть, нажав на +. Часто структура ответа имеет большую вложенность.

4. В случае ошибки в блоке Ответ отобразится код ошибки и описание.

   

Заголовки

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

Примеры кода

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

Swagger

Swagger — это фреймворк для спецификации RESTful API. Один из его инструментов, Swagger UI, позволяет не только интерактивно просматривать спецификацию, но и отправлять запросы.

Swagger UI — один из самых популярных инструментов для создания интерактивной документации. Swagger UI создает интерактивную консоль API для экспериментов с запросами в реальном времени.

Авторизация

Перед отправкой запросов вам нужно авторизоваться:

1. Нажмите Authorize.

   

2. Введите данные в окне Available authorizations и нажмите Authorize. В нашем примере нужно ввести токен токен доступа. Пример токена — Bearer t.QtEo8ahkNFX4RTpbqp0u4z4GDZq27HzUp6AotJASBx7_DVqmqZMHfM2Cy7JmUjS80boI9eVg.

   

Отправка запроса

Чтобы создать запрос:

1. Разверните конечную точку и нажмите Try it out.

   

   Значение примера в поле Request body станет редактируемым.

2. В редактируемом поле измените значения параметров и нажмите Execute.

   

Пользовательский интерфейс Swagger отправляет запрос и показывает отправленный curl. В разделе Responses можно посмотреть тело и заголовки ответа.

Если сервер обработал запрос корректно, вернется 200 ответ. Он показывает, как должна выглядеть структура ответа.

Для REST API характерны отдельные коды ошибок.