CAIKU / DATA SERVICES
API 服务
为企业应用提供标准化 REST API,使用 API Key 认证,以 JSON 格式返回公开数据。
REST APIJSONAPI Key 认证v1 版本调用统计来源与更新时间
01 / 获取 API Key
注册并登录企业账户,在用户中心创建密钥。完整密钥仅在创建时显示一次,请通过服务端环境变量保存。
Authorization: Bearer YOUR_API_KEY进入用户中心 →
02 / 接口目录
| 方法 / 路径 | 说明 | 筛选参数 |
|---|---|---|
GET /api/v1/companies | 企业列表 | q, industry |
GET /api/v1/companies/:id | 企业详情 | id(路径参数) |
GET /api/v1/datasets | 数据集目录 | — |
GET /api/v1/industry_data | 行业指标 | industry_name, indicator_name, period |
列表接口支持 page 和 per_page,默认每页 20 条,最大 100 条。批量读取请逐页请求,记录总数见 meta.total。
03 / 请求与响应
curl -H "Authorization: Bearer YOUR_API_KEY" "https://YOUR_DOMAIN/api/v1/companies/1001"
{
"data": {
"id": 1001,
"name": "示例科技有限公司",
"industry": "软件和信息技术服务业",
"source_url": "https://example.com/demo",
"demo": true,
"updated_at": "2026-09-01T00:00:00+08:00"
},
"meta": { "version": "v1" }
}API 示例数据仅用于接口格式展示。示例 ID 和域名不代表真实记录。列表接口的 data 为数组,详情接口的 data 为对象。
每条记录包含 updated_at;公开信息还提供来源、发布日期与采集时间。正式查询和接口不返回开发演示记录。
04 / 错误码与调用统计
| HTTP 状态 | 错误码 | 处理方法 |
|---|---|---|
| 401 | unauthorized | 检查密钥、账户状态或重新生成密钥 |
| 404 | not_found | 检查资源 ID,草稿和未发布记录不可访问 |
| 429 | rate_limited | 按 Retry-After 响应头等待后重试 |
{"error":{"code":"unauthorized","message":"API Key 无效或已撤销"}}成功认证且额度允许的调用会记录路径、状态、耗时和时间,可在用户中心查看。认证失败与超限请求不写入账户调用日志。