后端API集成参考
本文介绍轻量化引擎服务平台与业务端交互相关接口。API接入需要业务端自行完善与yunapi服务接口交互处理。业务端从 门户网站 获取 开发接口
信息,其中 接口地址 作为yunapi接口访问地址(定义为
[YunapiUrl]
),密钥、企业ID作为接口签名校验处理信息。
1. 文件上传
API | 描述 |
---|---|
GetPresignedUploadUrl | 获取临时授权路径,返回minio临时授权上传路径地址 |
2. 插入转换任务
API | 描述 |
---|---|
InsertTask | 单个插入3D模型,3D装配体模型,2D图纸等模型转换。每个任务会生成一份轻量化数据。注意插入装配体模型时,需要将装配体模型压缩为zip文件,并指定mainFile参数为主装文件名。 |
BatchInsertTask | 批次插入多个模型。支持将多个3D模型或2D模型压缩为zip压缩文件,使用该接口批量转换,服务端会对插入的模型进行拆分成多个子任务处理。查询批次插入任务,会返回子任务的列表信息。 |
InsertPartConvertAddTask | 子件转换任务,转换文件必须是zip压缩包文件,可对单个零件或装配体文件转换为与模型一一对应的轻量化数据信息。 |
InsertHtmlConvertTask | 插入离线预览html转换任务,使用转换后的轻量化数据及按需添加批注等信息数据,通过该接口可生成可离线预览的单个html文件。 |
InsertConvertFormatTask | 格式转换任务,支持将3D或2D模型转换为其他对应格式的文件。 |
3. 查询任务
API | 描述 |
---|---|
QueryTask | 查询除批量插入任务的转换信息,转换完成后,通过该接口可以获取转换后的预览地址和轻量化数据 |
QueryBatchTask | 查询批次转换信息,返回批次转换拆分后的子任务列表数据。 |
QueryMultiTask | 批量查询任务信息,支持多个任务ID使用“,”拼接成参数,统一查询返回 |
QueryTaskDetail | 查询任务详细信息,对比QueryTask的查询,新增转换时间、模型类型,轻量化文件大小,轻量化比信息、三角面片数等信息。不过该查询耗时更多。 |
QueryTaskModelInfo | 查询3D模型详细信息,返回结构信息、PMI信息、属性信息 url访问地址,仅本地私有化部署提供,需要手动开放配置,设置“NeedDataAnalysis”为1 |
QueryTaskModelFeatures | 查询模型特征信息,返回特征信息json文件url地址,文件包含特征信息,面片数、孔数量、孔的id 等 |
QueryViewUseinfo | 查询私有化部署配置的Viewer数量及当前已使用数量 |
QueryTaskQueues | 获取当前任务排队情况,获取前面还有多少个任务在排队处理 |
4. 回调信息
如果任务添加的回调地址( returnURL )不为空,服务器会在任务处理完成之后,调用第三方系统地址。请参考回调处理 returnURL 。