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

Методы 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 требуется авторизация. Для доступа к REST API инструментам ноды используется авторизация по списку tls-whitelist: необходимо, чтобы публичный ключ в клиентском TLS сертификате был равен одному из публичных ключей администраторов, перечисленных в разделе node.api.auth конфигурационного файла узла.

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

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

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

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

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