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

Методы REST API¶

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

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

Все вызовы методов REST API — это https-запросы GET, POST или DELETE к URL https://yournetwork.com/node-N/api-docs/swagger.json, содержащие соответствующие наборы параметров. Нужные группы запросов выбираются в интерфейсе Swagger посредством выбора маршрутов (routes) — URL к отдельным методам REST API. В конце каждого маршрута предусмотрена точка доступа (endpoint) — обращение к методу.

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

Для использования практически всех методов REST API требуется авторизация по api-key или JWT-токену.

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

При этом, для методов, связанных с доступом к ноде, предусмотрена исключительно авторизация по api-key:

доступ к keystore ноды (например, метод sign);
работа с группами доступа к приватным данным;
доступ к конфигурации ноды.

Если используется авторизация по JWT-токену, доступ к этим методам будет закрыт.

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

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

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

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

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