API 认证
了解如何通过 API 访问 OpenBait
OpenBait API 使用 API Key 进行认证,所有请求都需要在 Header 中携带认证信息。
获取 API Key
- 登录 控制台
- 进入 设置 > API 密钥
- 点击 创建密钥
- 复制并安全保存您的 API Key
API Key 只会显示一次,请妥善保存。如果丢失,需要重新创建。
认证方式
在所有 API 请求的 Header 中添加:
Authorization: Bearer your_api_key
基础 URL
https://api.openbait.com/v1
请求示例
curl -X GET "https://api.openbait.com/v1/threats" \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json"
响应格式
所有响应都是 JSON 格式:
{
"data": [...],
"meta": {
"total": 100,
"page": 1,
"per_page": 20
}
}
错误响应
{
"error": {
"code": "unauthorized",
"message": "Invalid API key"
}
}
| 状态码 | 描述 |
|---|---|
| 400 | 请求参数错误 |
| 401 | 认证失败 |
| 403 | 无权限访问 |
| 404 | 资源不存在 |
| 429 | 请求过于频繁 |
| 500 | 服务器错误 |
速率限制
- 免费版:60 次/分钟
- 专业版:600 次/分钟
- 企业版:不限制
超出限制时返回 429 状态码,响应头包含:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1705749600