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 | 服务器内部错误 |