API 概述与认证
API 概述与认证
简介
我们的 REST API 允许你以编程方式访问和管理资源。
Base URL: https://api.kygeehub.com/v1
认证方式
API Key
在请求头中添加:
X-API-Key: your_api_key_here
Bearer Token
对于需要用户上下文的操作:
Authorization: Bearer your_access_token
获取 API Key
- 登录 开发者控制台
- 点击「创建 API Key」
- 设置权限范围
- 安全保存生成的密钥
请求格式
- 所有请求使用 JSON 格式
- 字符编码:UTF-8
- 时间格式:ISO 8601
curl -X GET "https://api.kygeehub.com/v1/users" \
-H "X-API-Key: your_api_key" \
-H "Content-Type: application/json"
响应格式
{
"success": true,
"data": { ... },
"meta": {
"page": 1,
"total": 100
}
}
错误处理
| 状态码 | 含义 |
|---|---|
| 400 | 请求参数错误 |
| 401 | 未授权 |
| 403 | 权限不足 |
| 404 | 资源不存在 |
| 429 | 请求过于频繁 |
| 500 | 服务器错误 |

