请求结构

Header 与 Body 约定

请求头

X-API-Key: opd_xxx：API Key 鉴权（外部直连数据接口）
Authorization: Bearer <JWT>：资源库页面登录态（仅在线调试等页面操作，登录后自动携带）

外部直连（GET）

外部系统直接调用数据接口，路径为 /api/v1/data/{code}，参数放在 query string 中，fields 为必填（指定返回字段）。

GET /api/v1/data/co_info?limit=1&fields=sec_code,sec_name,org_name HTTP/1.1
Host: api.originp.com
X-API-Key: opd_your_api_key

资源库内调试（POST）

资源库内在线调试器走 POST 调试接口，路径为 /api/v1/docs/interfaces/{code}/debug，参数通过 JSON body 传入。

POST /api/v1/docs/interfaces/co_info/debug HTTP/1.1
Host: api.originp.com
Authorization: Bearer <JWT>

{
  "params": { "limit": "1" },
  "fields": ["sec_code", "sec_name", "org_name"]
}

统一响应结构

所有接口统一返回 JSON 结构，code 为 0 表示成功：

{
  "code": 0,
  "message": "success",
  "data": []
}

其他语言与工具

官方 SDK 目前仅支持 Python，安装命令：

pip install originp-sdk

其他语言可直接按上述 HTTP 协议调用。例如使用 curl：

curl -X GET 'https://api.originp.com/api/v1/data/co_info?fields=sec_code,sec_name,org_name' \
  -H 'X-API-Key: opd_your_api_key'

或在 Postman 中新建请求，填入上述 URL 与 Header 即可。