后端接入说明

1. 接入概述

业务端获取”开发接口信息“(门户网站获取)后通过轻量化引擎API服务,将数据上传到服务平台,然后调用API服务接口。服务平台将模型数据转换为轻量化数据后,提供轻量化数据压缩包文件和在线预览URL地址给业务端。

2. 接入流程

业务端接入轻量化引擎流程说明:

3. 接口调用说明

业务端-后端接入轻量化引擎,需要获取开发信息,进行签名处理,然后按照接口定义进行接入调用。

获取开发信息 :登录门户网站,在”开发信息“中可以查看对应的开发信息。

设置签名信息 : 业务端访问轻量化引擎数据所有服务接口时,需要将签名信息放在请求的Headers里面 ,用于接口校验。签名信息由接口信息生成,各个字段的含义及生成示例如下:

注意:apiKeyData密钥与shaKeyData必须存在一个。

字段 必选 类型 描述
timeStampData String 当前时间戳
partnerID String 开发信息中的”企业id“
apiKeyData String MD5 加密方式密钥
shaKeyData String SHA 加密方式密钥

时间戳 timeStampData 生成示例:

public static long DateTimeToUnixTimestamp(DateTime time)
 {
   var startTime = new DateTime(1970, 1, 1) + TimeZoneInfo.Local.BaseUtcOffset;
   return (long)(time - startTime).TotalSeconds;
 }
string timeStampData = StringPlus.DateTimeToUnixTimestamp(DateTime.Now).ToString();

密钥 apiKeyData 生成示例:

//partnerID 开发信息-企业ID
//partnerKey 开发信息-密钥
//timeStampData 上面生成的时间戳
string apiKeyData  = Md5(partnerID + partnerKey + timeStampData);

密钥 shaKeyData 生成示例:

//partnerID 开发信息-企业ID
//partnerKey 开发信息-密钥
//timeStampData 上面生成的时间戳
string shaKeyData  = SHA256(partnerID + partnerKey + timeStampData);

4. 轻量化数据回调说明

轻量化引擎服务支持插入任务时提供回调URL(returnURL),设置了returnURL的转换任务,在轻量化引擎服务转换完成后,会通过post请求returnURL方式,将轻量化数据相关信息回调到业务端。

如果不走回调方式的话,业务端可以主动调用查询任务接口(QueryTask),获取任务转换状态和转换结果信息。