REST API

API ของ Hivesigner อยู่ที่ https://hivesigner.com/api/ มันคืนบัญชีของผู้ที่เข้าสู่ระบบ กระจายการดำเนินการฝั่ง posting แทนเขา แลกโค้ดเป็นโทเค็น และแสดงรายการแอปที่ใช้ Hivesigner หน้านี้อธิบายแต่ละปลายทางพร้อมคำขอ คำตอบ และข้อผิดพลาด

คำขอและการยืนยันตัวตน

• URL ฐาน: https://hivesigner.com/api/ ทุกปลายทางด้านล่างเป็นเส้นทางสัมพัทธ์กับ https://hivesigner.com
• โทเค็น: ส่งไปตามเดิมในเฮดเดอร์ Authorization เป็น Authorization: ACCESS_TOKEN และรับคำนำหน้า Bearer ด้วย คุณจะส่งเป็น access_token ในสตริงคำค้นหรือในเนื้อหาก็ได้ แต่เฮดเดอร์ช่วยไม่ให้โทเค็นไปอยู่ใน 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 ไม่ได้ตรวจสอบรายการใดเลย