外观
接口总览
帮图产品开放 API(兼容版)共 22 个接口,覆盖从获取 token、创建项目、上传图纸,到发起审图、取回报告与识图结果的完整链路。
- 统一网关地址:
https://openapi.bangtu-ai.com - 公共请求头:除「2. 根据租户号获取 token」外,所有接口均需携带,详见接口调用前言
- 接口验签:
X-Sign = MD5(X-SecretKey + X-Nonce + X-Timestamp)
接口列表
| 序号 | 接口 | 请求方式 | 请求路径 |
|---|---|---|---|
| 1 | 接口调用前言 | — | — |
| 2 | 根据租户号获取 token | POST | /openApi/getToken |
| 3 | 查询所有省 | POST | /openApi/selectProjectProvince |
| 4 | 查询所有省下属市 | POST | /openApi/selectProjectCity/{pid} |
| 5 | 新建项目 | POST | /openApi/createProject |
| 6 | 上传图纸 | POST | /openApi/uploadDrawing |
| 8 | 查询预审信息 | POST | /openApi/selectByProjectIdAndMajor |
| 10 | 发起审图(新) | POST | /openApi/checkDrawingTask |
| 11 | 查询当前审图结果及历史任务的状态 | POST | /openApi/taskQuery |
| 12 | 获取审图报告(获取 PATH) | POST | /openApi/generateReport |
| 13 | 审图报告文件下载 | GET | /openApi/downLoadFile |
| 14 | 获取识图结果(违反要点和规范) | POST | /openApi/taskResultDetailForOpenApi |
| 15 | 接口调用顺序说明 | — | — |
| 16 | 帮图接口 code 及 message | — | — |
| 17 | 图纸文件下载 | GET | /openApi/downLoadDwgFile |
| 18 | 批量删除图纸 | POST | /openApi/deleteBatch |
| 19 | 查询审图任务图纸快照 | POST | /openApi/frameSnapshotForOpenApi |
| 20 | 误报规范存储 | POST | /openApi/mistrialOperation |
| 21 | 漏报规范存储 | POST | /openApi/addProofreadingOpinions |
| 22 | 修改子项信息 | POST | /openApi/updateBatch |
| 23 | 在线看图链接 | GET | /openApi/shareUrl |
| 24 | 修改子项类型 | POST | /openApi/updateResidenceUsage |
关于序号
接口序号沿用原文档编号。7、9 号接口在原文档中未提供,因此序号不连续。
推荐阅读顺序
- 阅读接口调用前言,确认网关地址、公共请求头与验签方式。
- 调用根据租户号获取 token获取 token、企业 id 与租户 id。
- 调用查询所有省、查询所有省下属市获取城市 id。
- 调用新建项目、上传图纸完成项目与图纸准备。
- 调用查询预审信息确认预审结果,必要时调用修改子项类型。
- 调用发起审图(新),再通过查询当前审图结果及历史任务的状态轮询任务状态。
- 任务
reviewStatus为SUCCESS后,调用获取审图报告与审图报告文件下载,或调用获取识图结果获取违反要点和规范的数据。
说明
完整的调用链路与顺序约束,请参阅接口调用顺序说明。