DEVELOPER DOCS / API V1

鉴权、账户与配额

以冻结的 v1 契约接入通信数据。示例均为合成结构,实际结果以当前数据集与账户权限为准。

服务端 API Key

HTTP HEADER
X-API-Key: YOUR_API_KEY

数据接口接受有效 API Key 或用户会话。密钥只以摘要提供列表,完整值仅在创建时返回;撤销后不能再使用。控制台操作必须使用账户会话,API Key 不能代替用户修改账户。

手机号验证码注册、登录与退出

仅支持中国大陆手机号(11位或 +86 格式)。协议版本为2026-09-08;验证码6位、5分钟有效,单次使用且最多5次错误验证。密码和邮箱认证已移除。未配置短信服务时返回503。

接口请求体data
POST /auth/sms/code{phone,agreed:true,terms_version,privacy_version}{challenge_id,expires_in,retry_after};发送前需同意当前版本协议,尚不创建账户。
POST /auth/login{phone,challenge_id,code,agreed:true,terms_version,privacy_version}{user,created},验证码校验后统一注册/登录并设置会话。
GET /auth/me{user};未登录返回 HTTP 401。
POST /auth/logout{logged_out:true},撤销当前会话。

User 字段:id,email,phone,name,plan,created_at。短信验证只核验手机号接收能力,不等于实名或企业认证。跨站写操作校验 Origin;前端使用同源凭证模式,不在 localStorage 保存会话。

密钥与用量管理

接口请求体data
GET /console/api-keys{items:ApiKeySummary[]}
POST /console/api-keys{name}{key,item},key 只显示一次。
DELETE /console/api-keys/:id{revoked:true}
GET /console/usage{period,used,quota,by_endpoint:[{endpoint,count}],daily:[{date,count}]}
GET /console/plan{current_plan,pricing_is_provisional:true,payment_enabled:false,plans:[...]}
GET /console/billing{items:[],payment_enabled:false},没有付款不生成账单。

ApiKeySummary 包含 id,name,prefix,created_at,revoked_at,last_used_at,不含完整密钥。仅成功查询计入月度配额,4xx/5xx 业务失败不扣减额度;速率限制仍按尝试次数计算。网页查询与 Key 共用账户额度,CSV/完整快照导出各计一次成功请求。用量页面显示实际额度、业务失败及下一次恢复时间;429 时遵循 Retry-After,避免无限重试。

会话管理与安全退出

接口结果
GET /console/sessions{items:[{id,created_at,expires_at,current}]}
DELETE /console/sessions/:id{revoked:true,current:boolean}
POST /console/sessions/revoke-others{revoked:number}

以上操作需要账户会话。在安全页撤销其他登录会话不会撤销 API Key。手机号停用、人工换绑或账户访问受限时,通过联系页面提供可核验信息;不要提交验证码或完整密钥。

企业咨询

POST /contact
{
  "name": "Example User",
  "email": "developer@example.com",
  "company": "Example Company",
  "message": "希望了解指定地区的数据范围和接入方式。"
}

成功 data 为{id,received:true}。咨询持久化到平台,不自动发送外部邮件;此操作不是付款。

响应、鉴权与错误

数据接口支持X-API-Key 或同源 Cookie 会话。匿名访问为受限公共投影,完整字段权限由 API 服务执行。JSON 成功响应统一为{code:0,data,meta};文件导出直接返回文件。

字段说明
meta.request_id本次请求标识,用于排查错误,不包含密钥。
meta.dataset_version / source_mode当前数据版本与 demo / ir21 / reference / mixed 来源模式。
meta.source_published_at源发布时间;未知为 null。
meta.ingested_at平台导入时间,ISO 格式 UTC。

400 表示参数不符,401 表示需要有效凭证,403 表示权限不足,429 表示调用限制,503 表示服务或数据源暂不可用。请读取错误响应的 codemessagerequest_id,详见错误与重试

ERROR / 示意结构
{
  "code": "EXAMPLE_ERROR_CODE",
  "message": "具体错误原因由服务端返回",
  "request_id": "example-request-id"
}