Прокси ноды — Справочник 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 | Ключи ноды аккаунта. |
Поля ответа
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
data | array of object (NodeKey) | да | |
data[].id | string | да | |
data[].label | string | null | да | |
data[].active | boolean | да | |
data[].created_at | string (date-time) | да | |
data[].last_used_at | string (date-time) | null | да | |
limit | integer | да | |
used | integer | да |
Создание ключа ноды; ключ и эндпоинт отображаются один раз
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.
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
label | string |
Ответы
| Статус | Значение |
|---|---|
201 | Создан. key и endpoint возвращаются только в этом ответе. |
409 | 3017 api_key_limit_reached. |
Поля ответа
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
id | string | да | |
label | string | null | да | |
active | boolean | да | |
created_at | string (date-time) | да | |
last_used_at | string (date-time) | null | да | |
key | string | да | 26 символов base32, 128 бит. |
endpoint | string | да | <PROXY_PUBLIC_HOST>/<key>. |
Отзыв ключа ноды (active = false)
DELETE /v1/node-keys/{id} · revokeNodeKey
Аутентификация: API-ключ (HMAC).
Тот же гард, что и для DELETE /api-keys/{keyId} (scope keys.revoke). Прокси перестает принимать ключ в пределах своего TTL кэша.
Параметры
| Параметр | Где | Тип | Обязательный | Описание |
|---|---|---|---|---|
id | path | string | да |
Ответы
| Статус | Значение |
|---|---|
204 | Отозван. |
404 | Ключ ноды не найден на этом аккаунте. |