📚 开放 API 接口文档

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

统一响应信封

全部响应为 UTF-8 JSON。成功含 success:true;失败含 success:false + error 码 + message 说明 + request_id(报障时请提供它)。

{ "success": false, "error": "wire_not_found", "message": "导线库中未找到型号:XYZ-999/99", "request_id": "a1b2c3d4e5f6..." }

错误码表

HTTPerror含义 / 处理
200—成功
400invalid_request参数缺失或无法解析,检查字段拼写与类型
400wire_params_incomplete导线库该型号缺关键参数,响应 missing 列出缺什么,手工补齐后重发
400coord_invalid_coords坐标值超出有效范围(经度 -180~180、纬度 -90~90;投影坐标核对 X/Y 与带号)
401missing_api_key请求头里没带 Key
401invalid_api_keyKey 无效或已被吊销
403scope_denied该 Key 作用域不含此接口,响应含 required 与 granted
404not_found接口路径不存在,用 GET /openapi/v1 查清单
404wire_not_found导线型号未找到,换简写或规格号重试(如 400/50)
405method_not_allowed请求方法不被允许
429quota_exceeded超出日配额,次日 0 点(北京时间)自动重置
500internal服务端异常,携带 request_id 反馈
502coord_backend_unreachable坐标服务暂不可用,可稍后重试

响应头

响应头含义
X-RateLimit-Limit本密钥每日配额上限
X-RateLimit-Remaining本次调用前剩余次数
X-RateLimit-Reset配额重置的 Unix 时间戳(北京时间次日 0 点)
X-Request-Id本次请求唯一 ID,排查问题时提供它
就绪 塔基: 0 粤公网安备44060502004295号 粤ICP备2026039854号-1