Меню документации

Прокси ноды — Справочник API

Ключи ноды для эндпоинта прокси ноды TRON.

МетодПутьОписание
GET/v1/node-keysСписок ключей ноды (сами ключи никогда не возвращаются)
POST/v1/node-keysСоздание ключа ноды; ключ и эндпоинт отображаются один раз
DELETE/v1/node-keys/{id}Отзыв ключа ноды (active = false)

Сгенерировано из openapi.yaml во время сборки. Базовый URL https://api.tenergy.me/v1 или https://api-nile.tenergy.me/v1 в сети Nile (Окружения). Каждый запрос ниже подписывается в соответствии с разделом Аутентификация, если в строке Аутентификация не указано иное.

Список ключей ноды (сами ключи никогда не возвращаются)

GET /v1/node-keys · listNodeKeys

Аутентификация: API-ключ (HMAC).

Тот же гард, что и для GET /api-keys (scope keys.read). used считает активные ключи; limit равен NODE_KEYS_PER_ACCOUNT (по умолчанию 5).

Ответы

СтатусЗначение
200Ключи ноды аккаунта.

Поля ответа

ПолеТипОбязательноеОписание
dataarray of object (NodeKey)да
data[].idstringда
data[].labelstring | nullда
data[].activebooleanда
data[].created_atstring (date-time)да
data[].last_used_atstring (date-time) | nullда
limitintegerда
usedintegerда

Создание ключа ноды; ключ и эндпоинт отображаются один раз

POST /v1/node-keys · createNodeKey

Аутентификация: API-ключ (HMAC).

Тот же гард, что и для POST /api-keys (scope keys.create, участник editor); без дополнительных scope. Ключ ноды позволяет прокси ноды автоматически покупать 5-минутные заявки энергии под транзакции, транслируемые через него, списывая средства с баланса данного аккаунта и ничего более. Сохраняется только его SHA-256 хеш. Ошибка 3017 api_key_limit_reached, если у аккаунта уже есть NODE_KEYS_PER_ACCOUNT активных ключей.

Тело запроса

JSON.

ПолеТипОбязательноеОписание
labelstring

Ответы

СтатусЗначение
201Создан. key и endpoint возвращаются только в этом ответе.
4093017 api_key_limit_reached.

Поля ответа

ПолеТипОбязательноеОписание
idstringда
labelstring | nullда
activebooleanда
created_atstring (date-time)да
last_used_atstring (date-time) | nullда
keystringда26 символов base32, 128 бит.
endpointstringда<PROXY_PUBLIC_HOST>/<key>.

Отзыв ключа ноды (active = false)

DELETE /v1/node-keys/{id} · revokeNodeKey

Аутентификация: API-ключ (HMAC).

Тот же гард, что и для DELETE /api-keys/{keyId} (scope keys.revoke). Прокси перестает принимать ключ в пределах своего TTL кэша.

Параметры

ПараметрГдеТипОбязательныйОписание
idpathstringда

Ответы

СтатусЗначение
204Отозван.
404Ключ ноды не найден на этом аккаунте.

    ↑ ↓ — выбрать · Enter — открыть · Esc — закрыть