REST API

API на Hivesigner е на https://hivesigner.com/api/. Той връща акаунта на влезлия потребител, излъчва posting операции от негово име, разменя кодове за токени и изброява приложенията, които използват Hivesigner. Тази страница описва всяка крайна точка с нейните заявки, отговори и грешки.

Заявки и удостоверяване

• Основен адрес: https://hivesigner.com/api/. Всяка крайна точка по-долу е относителна спрямо https://hivesigner.com.
• Токенът: изпращайте го като заглавка Authorization, както е: Authorization: ACCESS_TOKEN. Приема се и префикс Bearer . Можете да го изпратите и като access_token в query низа или в тялото, но заглавката го пази извън URL адресите и дневниците.
• Тела: 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

Подписва posting операции за потребителя на токена с posting ключа на @hivesigner и ги излъчва към Hive.

• Метод: POST.
• Токен: токен за достъп posting, от потока с токен или потока с код.
• Преди да работи: потребителят е дал posting правомощия на акаунта на вашето приложение (екранът за съгласие прави това) и акаунтът на приложението ви е дал 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

posting токен позволява на API да излъчва тези операции и никакви други. Във всяка от тях потребителят на токена трябва да е акаунтът в посоченото поле:

• Всяка друга операция се отказва с invalid_scope. login токен не позволява никаква операция.
• Операция за друг акаунт се отказва с unauthorized_client. Токенът излъчва само за собствения си потребител.
• account_update2 може да променя само метаданните на акаунта. Операция с поле owner, active или posting се отказва с unauthorized_client.
• custom_json: оставете required_auths празно. API подписва с posting правомощия, затова операция, която изисква active правомощия, се проваля в мрежата.

Преводите и другите операции с портфейла изискват active ключа на потребителя. Изпращайте ги вместо това като връзки за подпис.

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() в JavaScript SDK прави това извикване и след това забравя токена. За да премахнете достъпа на приложението си завинаги, потребителят го премахва на 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 не проверява нито едно от тях.