REST API

API Hivesigner berada di https://hivesigner.com/api/. API ini mengembalikan akun orang yang sudah masuk, menyiarkan operasi posting untuknya, menukar kode dengan token dan mendaftar aplikasi yang memakai Hivesigner. Halaman ini menjelaskan tiap titik akhir beserta permintaan, jawaban dan galatnya.

Permintaan dan autentikasi

• URL dasar: https://hivesigner.com/api/. Tiap titik akhir di bawah bersifat relatif terhadap https://hivesigner.com.
• Tokennya: kirim apa adanya sebagai tajuk Authorization: Authorization: ACCESS_TOKEN. Awalan Bearer juga diterima. Anda juga dapat mengirimnya sebagai access_token di rangkaian kueri atau di badan, tetapi tajuk menjauhkannya dari URL dan log.
• Badan: JSON dengan Content-Type: application/json, atau sebuah formulir (application/x-www-form-urlencoded).
• Jawaban: JSON.
• Peramban: API mengizinkan permintaan lintas asal, jadi aplikasi web dapat memanggilnya langsung.

Untuk mendapatkan token, lihat Masuk dengan OAuth2. Untuk isi sebuah token, lihat Token.

Galat

Jawaban galat punya status galat HTTP dan badan ini:

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

GET /api/me

Mengembalikan akun pemilik token. Pakai ini untuk mengetahui siapa yang masuk, atau untuk memeriksa sebuah token.

• Metode: GET atau POST.
• Token: sebuah token akses, termasuk token login yang menyebut sebuah aplikasi.

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

Jawabannya, dipendekkan:

{
  "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 tidak menyebut aplikasi tempat token itu dibuat. Untuk memeriksanya, dekode tokennya: lihat Bertanya ke API.

POST /api/broadcast

Menandatangani operasi posting milik orang pemilik token dengan kunci posting @hivesigner lalu menyiarkannya ke Hive.

• Metode: POST.
• Token: token akses posting, dari alur token atau alur kode.
• Sebelum ini bekerja: orang itu sudah memberi otoritas posting kepada akun aplikasi Anda (layar persetujuan melakukannya) dan akun aplikasi Anda sudah memberi otoritas posting kepada @hivesigner.
• Badan: { "operations": [...] }, dengan tiap operasi berupa [name, fields] seperti di rantai blok Hive. Semua operasi dalam satu permintaan masuk ke satu transaksi.

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 }]
  ]
}

Permintaan yang sama dengan 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}]]}'

Mengikuti seseorang adalah operasi custom_json:

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

API menjawab begitu sebuah simpul Hive menerima transaksinya. result.id adalah id transaksinya:

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

Ketika jaringan menolak transaksinya, jawabannya 500 dengan server_error. error_description miliknya membawa pesan jaringan dan response membawa galat mentahnya.

Yang diterima broadcast

Token posting membolehkan API menyiarkan operasi-operasi ini dan tidak yang lain. Pada tiap operasi, orang pemilik token harus menjadi akun pada ruas yang ditunjukkan:

• Operasi lain apa pun ditolak dengan invalid_scope. Token login tidak mengizinkan satu operasi pun.
• Operasi untuk akun lain ditolak dengan unauthorized_client. Sebuah token hanya pernah menyiarkan untuk orangnya sendiri.
• account_update2 hanya dapat mengubah metadata akun. Operasi dengan ruas owner, active atau posting ditolak dengan unauthorized_client.
• custom_json: biarkan required_auths kosong. API menandatangani dengan otoritas posting, jadi operasi yang memerlukan otoritas active akan gagal di jaringan.

Transfer dan operasi dompet lainnya memerlukan kunci active orang itu. Kirimkan semua itu sebagai tautan tanda tangan saja.

POST /api/oauth2/token

Menukar kode dengan token, atau token penyegaran dengan token baru. Panggil hanya dari server Anda. Lihat Alur kode.

• Metode: POST, dengan nilai-nilainya di badan.
• Badan: code dan client_secret, atau refresh_token dan client_secret.
• Tajuk: jangan mengirim tajuk Authorization apa pun.

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"
}

Tiap panggilan mengembalikan token akses baru dan token penyegaran baru. Keduanya ditandatangani @hivesigner. expires_in adalah umur token akses dalam detik (7 hari).

Galat: 401 invalid_grant. Keterangannya "The token has invalid role" ketika nilai yang dikirim bukan kode atau token penyegaran yang sah. Keterangannya "The code or secret is not valid" ketika kode atau rahasianya tidak cocok.

POST /api/oauth2/token/revoke

Memberi tahu Hivesigner bahwa orang itu sudah keluar dari aplikasi Anda. Aplikasi Anda membuang tokennya sendiri.

• Metode: POST.
• Token: token akses, di tajuk Authorization.

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

{ "success": true }

revokeToken() milik SDK JavaScript melakukan panggilan ini lalu melupakan tokennya. Untuk mencabut akses aplikasi Anda selamanya, orang itu mencabutnya di https://hivesigner.com/authorized-apps. Lihat Keluar dan mencabut akses.

GET /api/apps

Direktori aplikasi publik: aplikasi yang menyiarkan lewat Hivesigner, diurutkan menurut berapa banyak orang yang memakainya. Tidak memerlukan token. https://hivesigner.com/apps menampilkan daftar yang sama.

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
    }
  ]
}

Jawabannya boleh disinggahkan sampai 5 menit. Sebelum direktori dibangun pertama kali, API menjawab 503 dengan unavailable. Coba lagi nanti.

Nama dan keterangannya diterbitkan oleh tiap akun aplikasi sendiri. Hivesigner tidak memeriksa satu pun.