📚 开放 API 接口文档

用 API Key 让 AI / 脚本直接调用本站的计算与数据能力

两种写法,二选一

方式请求头适用场景
Bearer(推荐)Authorization: Bearer sdgj_xxxx…curl / Python / Node / PHP 等绝大多数 HTTP 客户端
自定义头X-API-Key: sdgj_xxxx…某些不方便改 Authorization 头的客户端

安全须知

不要把 Key 写进前端页面、小程序或公开仓库。它等同于你的账号身份,任何人拿到都能消耗你的配额。 只放在服务端、本地脚本或你自己的 AI 助手配置里。发现泄露请到个人中心立即吊销。
  • Key 在数据库里以 SHA-256 哈希参与鉴权(另存一份 AES-256-GCM 加密副本, 因此在个人中心可随时点「复制」取回明文;主密钥在服务器 Web 目录之外)。
  • Key 前缀 sdgj_ 只是本站品牌标识,与功能模块无关; 能调哪些接口由作用域决定(* 表示全部开放接口)。
  • 吊销是软删除:Key 立即失效,但历史调用日志保留,便于追溯。
  • 建议为不同用途申请不同 Key(如「AI 助手」「运维脚本」),出问题时只吊销那一把,不影响其他。

作用域(scope)

申请 Key 时可以限定它能访问哪些接口,多个用空格分隔:

作用域允许访问
*全部已接入接口(默认)
zlljs:calc导线载流量计算
tldb:read导线参数库读取
huchui:calc张力弧垂计算
cptool:coord坐标转换(cgcs2wgs / wgs2cgcs / batch)
cptool:cad坐标 → CAD/GIS 文件(DXF / KML / SHP 共 6 个接口)

访问未授权接口会返回 403 scope_denied,响应里会带上 required 与 granted 便于排查。

就绪 塔基: 0 粤公网安备44060502004295号 粤ICP备2026039854号-1