BIMFACE服务器端API接口

回调机制

BIMFACE支持回调机制。在调用方发起模型转换、模型集成、模型对比、生成离线数据包等操作时,可以通过传入参数callback的方式来启用回调机制。 在BIMFACE处理完相应操作后,根据调用方传入的回调地址通知调用方相应操作的结果。

callback 说明

GET callback地址
Url 参数
字段 类型 描述 示例

fileId

Number

文件ID(与集成ID,对比ID三选一)

85929027838566

integrateId

Number

集成ID(与文件ID,对比ID三选一)

85929027838566

compareId

Number

对比ID(与文件ID,集成ID三选一)

85929027838566

thumbnail

String

缩略图地址,多个缩略图用","分隔(该字段适用于发起模型转换、模型集成、模型对比)

38044a282f55cb26e3704643dccd2b55/thumbnail/256.png

status

String

模型处理状态或者数据包处理状态:processing(进行中),success(完成),failed(失败)

reason

String

若模型处理失败或者数据包处理失败,则返回失败原因

nonce

String

回调随机数

signature

String

签名

signature(签名):为了确保回调消息是由BIMFACE发出的,调用方在收到回调消息后,须验证签名。签名的计算方式:MD5(``appKey:appSecret:compareId:status:nonce''),如果调用方计算的签名与BIMFACE返回的签名一致,则证明该消息是安全可靠的。
消息回执
应用收到回调后,须向BIMFace发送回执,回执消息:HTTP STATUS 200
callback 示例
* 调用方对文件1685236328506848发起了模型转换,并且传入的回调地址是:https://my.app.com/callback。

* BIMFACE在模型转换任务处理完成后,会发送一个get请求到调用方的callback地址:
 https://my.app.com/callback?fileId=1685236328506848&status=success&thumbnail=38044a282f55cb26e3704643dccd2b55/thumbnail/96.png,38044a282f55cb26e3704643dccd2b55/thumbnail/256.png&reason=&signature=99a6fccb1894dfdb4cce48fd5ec58110&nonce=123abc

* 调用方接收到这条请求后,可以进行signature的验证,并发送回执消息。