API 文件
使用我們安全的 REST API 和基於令牌的身份驗證以程式設計方式訪問你的加密資料。
章節
入門指南
在帳戶設定中生成 API 金鑰以開始
要使用 Hexbon API，你需要從 帳戶設定 → API 設定 頁面生成 API 金鑰。API 使用兩步身份驗證流程以增強安全性。
身份驗證流程
1
請求令牌
使用你的 API 金鑰透過 POST /api/v1/auth 請求臨時訪問令牌
2
令牌有效期
令牌有效期為 60 分鐘。過期後，請求新令牌。
3
使用令牌
在 Authorization: Bearer <token> 請求頭中包含令牌以進行資料操作。
速率限制
API 限制為每個使用者每分鐘 10 次請求。超過此限制將返回 429 Too Many Requests 響應。
端點
身份驗證
POST
https://hexbon.com/api/v1/auth
使用你的 API 金鑰生成臨時訪問令牌。
請求頭
| X-API-Key | 你的 API 金鑰（必填） |
請求示例
curl -X POST "https://hexbon.com/api/v1/auth" \ -H "X-API-Key: your_api_key_here"
響應示例
{
"success": true,
"bearer_token": "abc123def456...",
"expires_at": "2025-11-27T15:30:00Z",
"expires_in": 3600
}
讀取
GET
https://hexbon.com/api/v1/data
檢索你的加密資料。返回客戶端加密的有效負載 (v1:...)。
請求頭
| Authorization | Bearer <token>（必填） |
請求示例
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
響應示例
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
更新
POST
https://hexbon.com/api/v1/data
儲存你的加密資料。在請求體中接受客戶端加密的有效負載 (v1:...)。
注意： 必須在 API 設定 中啟用寫入許可權。預設情況下，API 訪問為只讀。
請求頭
| Authorization | Bearer <token>（必填） |
| Content-Type | application/json（必填） |
請求體
| data | 以 v1: 開頭的客戶端加密有效負載（必填） |
請求示例
curl -X POST "https://hexbon.com/api/v1/data" \
-H "Authorization: Bearer your_token_here" \
-H "Content-Type: application/json" \
-d '{"data": "v2:your_encrypted_payload"}'
響應示例
{
"success": true,
"message": "Encrypted data saved successfully."
}
響應格式
所有 API 響應都以 JSON 格式返回，包含 success 布林欄位表示操作結果。
成功響應
{ "success": true, "data": "..." }
錯誤響應
{ "success": false, "message": "Error description" }
錯誤程式碼
| 程式碼 | 描述 |
|---|---|
| 401 | 無效或缺少 API 金鑰 / 令牌已過期 |
| 403 | 寫入許可權已禁用（用於 POST /data） |
| 422 | 無效的有效負載格式或超出儲存限制 |
| 429 | 超出速率限制（每分鐘 10 次請求） |
| 500 | 伺服器內部錯誤 |