Установка и использование платформы

Методы REST API

REST API позволяет пользователям удалённо взаимодействовать с нодой через запросы и ответы в формате JSON. Работа с API происходит по протоколу https. В качестве интерфейса к REST API применяется фреймворк Swagger.

Использование REST API

Все вызовы методов REST API — это HTTP-запросы GET, POST или DELETE к URL https://yournetwork.com/node-N, содержащие соответствующие наборы параметров.

Платформа также предоставляет доступ к интерфейсу Swagger https://yournetwork.com/node-N/api-docs/index.html, который позволяет составлять и отправлять HTTP-запросы в ноду через веб-интерфейс. Нужные группы запросов выбираются в интерфейсе Swagger посредством выбора маршрутов (routes) — URL к отдельным методам REST API.

В конце каждого маршрута предусмотрена точка доступа (endpoint) — обращение к методу.

Пример запроса о размере UTX-пула:

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

Порт прослушивания REST API запросов задаётся в параметре api.rest.port конфигурационного файла ноды; как правило используется порт 6862.

Для использования практически всех методов REST API требуется авторизация по api-key или JWT-токену (oAuth2 авторизация). Способ авторизации задаётся в секции auth конфигурационного файла ноды.

При авторизации по api-key при вызове метода укажите значение выбранной ключевой фразы, а при авторизации по JWT-токену – значение access-токена.

При авторизации по JWT-токену пользователю присваивается роль (или несколько ролей), от которой зависит возможность доступа к тем или иным методам REST API. Подробнее см. разделы Сервис авторизации и Роли для авторизации через oAuth2.

Для чего предназначен REST API платформы

Вы можете использовать интерфейс REST API для выполнения следующих задач:

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

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

Если авторизация не требуется, вы увидите значок badge1.