外观
1. openApi 接口调用前言
基础约定
- 所有接口必须经过验签通过后方可调用。
- 统一网关地址:
https://openapi.bangtu-ai.com - 除「2. 根据租户号获取 token」接口外,其他所有接口入参必须带上以下参数:
| 名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| Tenant | Header | 是 | 租户 Id |
| Authorization | Header | 是 | token |
| Enterprise | Header | 是 | 企业 id |
| X-SecretKey | Header | 是 | 秘钥 |
| X-Nonce | Header | 是 | 随机数 |
| X-Timestamp | Header | 是 | 时间戳 |
| X-Sign | Header | 是 | 签名 |
| Platform | Header | 是 | 智能体类型(INSPECTOR 审图平台、QUANTITY 算量平台、COMPARE 比对平台、FIRE 消防平台、PROOFREAD 校对平台、JOINT_REVIEW 会审平台) |
接口验签
所有接口都需要进行验签,制作签名方式如下:
| Header key | Header Value |
|---|---|
| tenantNum | 我司提供 |
| X-SecretKey | 我司提供 |
| X-Nonce | 建议用 Hutool UUID 生成,例如 01977917-d683-4b1b-b2e7-fb92024dc0a2 |
| X-Timestamp | 当前时间戳 |
| X-Sign | 把上述 X-SecretKey、X-Nonce、X-Timestamp 的 value 按次序进行字符串相加后计算 MD5 值 |
专业枚举
| 名称 | 类型 | 描述 |
|---|---|---|
| 专业 | enum | BUILDING(建筑)、STRUCTURE(结构)、DRAINAGE(给排水)、HEATING(暖通)、ELECTRICAL(电气) |
任务状态枚举
| 名称 | 类型 | 描述 |
|---|---|---|
| 状态 | enum | PROCEED(审图中)、SUCCESS(审图成功)、FAIL(失败)、CANCEL(取消)、ABORT(运营平台手动中止任务)、OUT_TIME(超时任务) |
图纸预审状态枚举
| 名称 | 类型 | 描述 |
|---|---|---|
| 状态 | enum | PRETRIAL(预审中)、PRETRIAL_SUCCEED(预审成功)、T3_CONVERTING(T3 转换中)、OTHER_ISSUE(其他问题)、FILE_ISSUE(文件问题)、VERSION_ISSUE(版本问题) |
查询预审信息
注意
为提升用户体验,天正文件如果未转 T3 会导致预审失败。就此类问题我们做了技术提升,即我们会自动帮助用户将图纸转为 T3。 在调用 8. 查询预审信息接口时,如果 t3Converted 为 true,说明此类图纸是已经经过转 T3 的了,此时的 id 是转 T3 成功后的图纸 id,originFileId 为原始图纸 id。
请求头需要添加 project
部分接口请求头中需添加 project,请求示例请参考对应的接口。
业务方案性缺陷
帮图提供的任何接口,对场景层面,因方案设计缺陷、不符合行业惯例、与 AI 智能审图常识不符导致的业务场景不匹配,不做任何的方案性兜底。如整体方案缺陷造成的对接问题需自行适配业务调整。请对接同学提前确认具体产品业务层面无缺陷。
各专业识图
除了建筑、结构专业发起识图外,其他专业(暖通、电气、给排水)需要先上传其对应的建筑专业图纸,需要和建筑专业图纸联动进行 AI 审查。请先在本项目建筑专业入口上传建筑专业图纸并完成预审后,再开始 AI 审查。
各平台枚举
| 名称 | 类型 | 描述 |
|---|---|---|
| 平台 | enum | INSPECTOR(AI 识图智能体)、QUANTITY(算量智能体)、COMPARE(比对智能体)、FIRE(消防智能体) |