外观
快速开始
本指南将帮助您在几分钟内完成帮图产品开放API的接入。
1. 基础路径
所有 API 请求均使用以下基础路径：
text
https://openapi.bangtu-ai.com/openApi完整请求地址由基础路径与接口请求地址拼接而成。例如「上传图纸」接口的完整地址为：
text
https://openapi.bangtu-ai.com/openApi/uploadDrawing2. 获取 API Key
API Key 可以从帮图开放平台上获取：https://open.bangtu-ai.com
3. 认证方式
所有 API 请求需要在 Header 中携带 API Key：
bash
curl -X POST https://openapi.bangtu-ai.com/openApi/...... \
-H "apiKey: YOUR_API_KEY"4. 公共请求头
除 apiKey 外，部分接口还需要携带下列公共请求头。请求头名称不区分大小写。
| 请求头 | 必填 | 说明 |
|---|---|---|
| apiKey | 是 | API 访问凭证，由平台分配 |
| Platform | 部分接口必填 | 平台标识，由平台分配并在接入时约定 |
| Tenant | 部分接口必填 | 租户标识 |
| Enterprise | 部分接口必填 | 企业标识 |
| project | 部分接口必填 | 项目标识，与请求体中的 projectId 保持一致 |
| Content-Type | 视接口而定 | JSON 接口使用 application/json；文件上传接口使用 multipart/form-data |
各接口实际必填的请求头以对应接口文档中的「请求头」小节为准。请求头缺失时接口会返回参数校验失败。
Platform 取值
| 取值 | 说明 |
|---|---|
| INSPECTOR | 审图平台 |
| QUANTITY | 算量平台 |
| MIDDLE_GROUND | 中台平台 |
| COMPARE | 比对平台 |
| FIRE | 消防平台 |
| PROOFREAD | 校对平台 |
| JOINT_REVIEW | 会审平台 |
5. 响应格式
所有 API 返回统一的 JSON 格式：
json
{
"code": 200,
"message": "success",
"data": {
// 具体业务数据
},
"timestamp": 1784533680000
}状态码说明
| code | 说明 |
|---|---|
| 200 | 请求成功 |
| 500 | 请求失败，具体原因见 message |
| 500001 | IP 黑名单拦截，请联系管理员 |
| 500003 | 请求过于频繁，请稍后再试 |
| 401 | apiKey 不存在或已禁用 |
| 2034 | 您已切换企业，请切换企业后重试 |
| 2003 | 没有相关权限 |
6. 通用响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| code | Number | 通用响应码，200 表示成功 |
| message | String | 响应信息 |
| data | Object | null | 业务数据；请求失败时为 null |
| timestamp | Number | 服务端响应时间戳，单位为毫秒 |
7. 典型接入流程
- 调用 新增项目 创建项目，获取
projectId。 - 调用 上传图纸 上传 DWG 图纸，得到文件信息。
- 调用 上传图纸完成并开启预审 提交图纸并触发预审。
- 调用 查询图纸信息 获取图框列表，确认审查范围。
- 调用 开启 AI 智能审查 创建审图任务。
- 调用 任务查询 轮询任务状态，或接收 审图结果回调。
- 调用 审图任务图纸详情 获取审查结果。
- 调用 下载报告 获取 WORD / PDF 报告。
8. 更多帮助
如需获取更详细的接口文档，请参考各功能模块 API 页面。如有任何问题，请联系技术支持团队。