3

接口文档

查看接口说明、认证方式、参数定义、返回示例和错误码。
基础说明
基础地址https://api.example.com
认证方式使用 Header 传递 API Key:Authorization: Bearer YOUR_API_KEY;不建议使用 Query String 传递密钥。
白名单要求当前账号请求来源 IP 必须命中白名单。
限流说明超出频率限制或配额限制均返回 429。
返回头说明X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset
错误码说明401 INVALID_API_KEY、403 IP_NOT_ALLOWED、403 PERMISSION_DENIED、429 RATE_LIMIT_EXCEEDED、429 QUOTA_EXCEEDED
接口导航
威胁情报单条查询
路径/api/threat-intelligence/{id}请求方法GET
用途说明适用于按情报编号拉取单条详情。当前账号权限状态已开通
当前账号频率限制20 req/s / 600 req/min
请求头说明
Authorization: Bearer YOUR_API_KEY
请求参数
序号参数类型必填说明
1keywordstring检索关键词
2pageSizenumber每页数量
返回字段
基础字段、风险标签、来源摘要、关联实体
请求示例
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.example.com/api/threat-intelligence/{id}
响应示例
{
  "code": 0,
  "data": [
    {
      "id": "sample",
      "risk": "high"
    }
  ],
  "quota": {
    "remaining": 984321
  }
}
错误码
序号错误码说明
1401 INVALID_API_KEYAPI Key 无效
2403 IP_NOT_ALLOWED来源 IP 未命中白名单
3403 PERMISSION_DENIED接口权限不足
4429 RATE_LIMIT_EXCEEDED超过限制
5429 QUOTA_EXCEEDED超过限制