Code Call · Quick Start

开发文档

一个 HTTPS 接口查询中国大陆登记企业(不含港澳台及海外)。三步:兑换积分拿到 API 密钥 → 选维度 → 调用 POST /v1/query。

你的API密钥

兑换积分后自动生成密钥,示例里的密钥会替换成你的。

认证

每个请求带上请求头 Authorization: Bearer 你的API密钥。密钥在首页「我的余额」复制或重置,重置后旧密钥立即失效。请只在服务端保存密钥。

查询接口

POST/v1/query

请求体(JSON)

字段类型说明
dimensionstring维度接口名,如 兑换后可见。完整列表见 可查维度 或 GET /v1/dimensions
keywordstring企业全称或统一社会信用代码,最长 100 字(「企业准确性验证」填统一社会信用代码)
paramsobject可选。少数维度需要的附加参数,见下表;维度不需要时不传。传了该维度不支持的参数会返回 400

附加参数 params

每个维度支持哪些参数、是否必填,以 GET /v1/dimensions 返回的 params 为准(required: true 为必填,enum 为可选值)。缺少必填参数时返回 400 和中文提示,不扣分。

参数类型说明
person_namestring人员姓名。企业人员信息类维度(董监高相关)必填,配合 keyword 填该人员所在企业
company_namestring企业全称。「企业准确性验证」必填,用来核对与 keyword 里的统一社会信用代码是否一致
document_idstring文书ID。「裁判文书详情」必填,取自「裁判文书」维度结果里的「文书ID」
sectionstring「裁判文书详情」可选:核心裁判(默认)、诉辩主张、审理与执行经过、全部
year role date_from status type sentiment—部分维度的可选筛选条件(年份、角色、起始日期、状态、类型、情感倾向),是否支持以该维度的 params 为准

  

响应格式

成功时 ok 为 true,data 是该维度的数据;points_charged 为本次扣分,命中 1 小时缓存时为 0 且 cached 为 true。


  

该企业在所查维度下没有记录时,no_data 为 true,data 里是一句「未发现任何记录」的说明而不是空列表;这同样是一次完成的查询,正常扣分(1 小时内重复查询不扣分)。


  

失败时返回 HTTP 状态码和 {"ok": false, "error": "中文说明"},可直接展示给你的用户。

错误码

状态码含义建议处理
400请求格式不正确检查 JSON、keyword 是否为空,以及该维度要求的 params 是否填齐
401API 密钥无效重新复制密钥;重置过密钥需更新
402积分不足兑换或续费后重试,余额可用 GET /v1/balance 查看
403账户已冻结联系客服
404维度不存在用 GET /v1/dimensions 核对接口名
429同时进行的查询超过套餐并发等待正在进行的查询完成后重试
503服务繁忙稍后重试,失败的查询不扣分

并发与限流

每个账户同时进行的查询数受套餐并发限制:轻量 1、标准 3、旗舰 5,没有每日卡时为 1,超出返回 429。批量查询请按并发数排队调用,不要无限重试。

同一企业同一维度 1 小时内重复查询直接返回缓存,不扣分。扣分顺序:先每日额度,再体验积分(先到期先用)。每日额度北京时间 0 点重置,不结转。

其他接口

GET/v1/dimensions

全部可查维度:接口名、名称、分类、说明、返回字段、积分,以及附加参数 params。

GET/v1/balance

今日可用积分、每日额度剩余、体验积分批次与到期时间、并发数。

维度示例

选择维度,自动生成对应的调用代码。

curlPythonJavaScript