REST API

API Hivesigner находится по адресу https://hivesigner.com/api/. Он возвращает аккаунт вошедшего человека, отправляет за него постинг-операции, обменивает коды на токены и перечисляет приложения, которые используют Hivesigner. На этой странице описан каждый адрес с его запросами, ответами и ошибками.

Запросы и аутентификация

• Базовый адрес: https://hivesigner.com/api/. Каждый адрес ниже указан относительно https://hivesigner.com.
• Токен: отправляйте его как есть в заголовке Authorization: Authorization: ACCESS_TOKEN. Принимается и префикс Bearer . Можно отправить его и как access_token в строке запроса или в теле, но заголовок удерживает его вне адресов и журналов.
• Тела: JSON с Content-Type: application/json или форма (application/x-www-form-urlencoded).
• Ответы: JSON.
• Браузеры: API разрешает запросы с другого источника, поэтому веб-приложение может обращаться к нему напрямую.

Как получить токен, смотрите в Вход через OAuth2. Что содержит токен, смотрите в Токены.

Ошибки

Ответ с ошибкой имеет статус ошибки HTTP и такое тело:

{
  "error": "invalid_scope",
  "error_description": "The access_token scope does not allow the following operation(s): transfer"
}

GET /api/me

Возвращает аккаунт, которому принадлежит токен. Используйте это, чтобы узнать, кто вошёл, или чтобы проверить токен.

• Методы: GET или POST.
• Токен: токен доступа, в том числе токен login, называющий приложение.

curl https://hivesigner.com/api/me -H 'Authorization: ACCESS_TOKEN'

Ответ, сокращённо:

{
  "user": "alice",
  "_id": "alice",
  "name": "alice",
  "account": { "id": 1370484, "name": "alice" },
  "scope": [
    "vote",
    "comment",
    "delete_comment",
    "comment_options",
    "custom_json",
    "claim_reward_balance",
    "account_update2"
  ],
  "user_metadata": { "profile": { "name": "Alice", "version": 2 } }
}

/api/me не называет приложение, для которого создан токен. Чтобы это проверить, раскодируйте токен: смотрите Спросите API.

POST /api/broadcast

Подписывает постинг-операции человека из токена постинг-ключом @hivesigner и отправляет их в сеть Hive.

• Метод: POST.
• Токен: токен доступа posting, из потока с токеном или из потока с кодом.
• Чтобы это работало: человек дал постинг-полномочия аккаунту вашего приложения (это делает экран согласия), а аккаунт вашего приложения дал постинг-полномочия @hivesigner.
• Тело: { "operations": [...] }, где каждая операция — это [name, fields], как в блокчейне Hive. Все операции одного запроса попадают в одну транзакцию.

POST /api/broadcast HTTP/1.1
Host: hivesigner.com
Authorization: ACCESS_TOKEN
Content-Type: application/json

{
  "operations": [
    ["vote", { "voter": "alice", "author": "bob", "permlink": "my-first-post", "weight": 10000 }]
  ]
}

Тот же запрос через curl:

curl -X POST https://hivesigner.com/api/broadcast \
  -H 'Authorization: ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"operations":[["vote",{"voter":"alice","author":"bob","permlink":"my-first-post","weight":10000}]]}'

Подписка — это операция custom_json:

{
  "operations": [
    ["custom_json", {
      "required_auths": [],
      "required_posting_auths": ["alice"],
      "id": "follow",
      "json": "[\"follow\",{\"follower\":\"alice\",\"following\":\"bob\",\"what\":[\"blog\"]}]"
    }]
  ]
}

API отвечает, как только узел Hive принял транзакцию. result.id — это идентификатор транзакции:

{
  "result": { "id": "TRANSACTION_ID" }
}

Когда сеть отклоняет транзакцию, ответом будет 500 с server_error. Его error_description несёт сообщение сети, а response — необработанную ошибку.

Что принимает broadcast

Постинг-токен позволяет API отправлять эти операции и никакие другие. В каждой из них человек из токена должен быть аккаунтом в указанном поле:

• Любая другая операция отклоняется с invalid_scope. Токен login не разрешает ни одной операции.
• Операция за другой аккаунт отклоняется с unauthorized_client. Токен отправляет операции только за своего человека.
• account_update2 может менять лишь метаданные аккаунта. Операция с полем owner, active или posting отклоняется с unauthorized_client.
• custom_json: оставляйте required_auths пустым. API подписывает постинг-полномочиями, поэтому операция, которой нужны активные полномочия, не пройдёт в сети.

Переводам и другим кошельковым операциям нужен активный ключ человека. Отправляйте их как ссылки подписи.

POST /api/oauth2/token

Обменивает код на токены или токен обновления на новые токены. Вызывайте это только со своего сервера. Смотрите Поток с кодом.

• Метод: POST, значения в теле.
• Тело: code и client_secret либо refresh_token и client_secret.
• Заголовки: не отправляйте заголовок Authorization.

curl -X POST https://hivesigner.com/api/oauth2/token \
  -H 'Content-Type: application/json' \
  -d '{"code": "CODE", "client_secret": "CLIENT_SECRET"}'

{
  "access_token": "ACCESS_TOKEN",
  "refresh_token": "REFRESH_TOKEN",
  "expires_in": 604800,
  "username": "alice"
}

Каждый вызов возвращает новый токен доступа и новый токен обновления. Оба подписаны @hivesigner. expires_in — это срок жизни токена доступа в секундах (7 дней).

Ошибки: 401 invalid_grant. Описание будет «The token has invalid role», когда присланное значение не является действительным кодом или токеном обновления. Оно будет «The code or secret is not valid», когда код или секрет не совпадают.

POST /api/oauth2/token/revoke

Сообщает Hivesigner, что человек вышел из вашего приложения. Токен ваше приложение выбрасывает само.

• Метод: POST.
• Токен: токен доступа, в заголовке Authorization.

curl -X POST https://hivesigner.com/api/oauth2/token/revoke -H 'Authorization: ACCESS_TOKEN'

{ "success": true }

Метод revokeToken() из SDK для JavaScript выполняет этот вызов, а затем забывает токен. Чтобы навсегда убрать доступ вашего приложения, человек убирает его на https://hivesigner.com/authorized-apps. Смотрите Выход и отзыв доступа.

GET /api/apps

Открытый каталог приложений: приложения, которые отправляют операции через Hivesigner, упорядоченные по числу пользователей. Токен не нужен. https://hivesigner.com/apps показывает тот же список.

curl https://hivesigner.com/api/apps

{
  "updated_at": "2026-09-19T06:00:00.000Z",
  "building": false,
  "window_days": 7,
  "featured": ["myapp"],
  "apps": [
    {
      "username": "myapp",
      "name": "My App",
      "about": "A short description from the app's profile.",
      "website": "https://myapp.example",
      "site": "ok",
      "users": 412,
      "requests": 9310,
      "first_seen": "2026-08-01",
      "last_seen": "2026-09-19",
      "new": false
    }
  ]
}

Ответ может храниться в кеше до 5 минут. Пока каталог не собран впервые, API отвечает 503 с unavailable. Попробуйте позже.

Названия и описания публикует каждый аккаунт приложения сам. Hivesigner ни одно из них не проверяет.