接入指引
- 申请授权证书并进行授权。
- 获取应用信息access_key(简称ak)、 secret_key(简称sk)。开发者在接口调用时,使用ak、sk生成WPS-4签名进行鉴权。
- 在线编辑、在线预览、格式转换接入按照对应开放能力文档接入。在线编辑、在线预览对接过程中需要设置回调地址。
- 使用过程中需通过证书查询接口关注授权证书状态,若证书即将过期或者不可用,需进行更新证书操作。
- 在线编辑或在线预览服务端对接完毕,对接方可使用jssdk,调用API实现相关需求。
应用信息
access_key、secret_key获取
获取应用信息
access_key(简称ak)、 secret_key(简称sk)需在服务器上执行以下命令获取。
回调地址设置
在线编辑、在线预览能力使用过程中会回调对接方接口,因此对接方需设置回调地址。设置回调地址需在每台机器上执行以下命令,其中access_key和secret_key需从3.1.2.1中获取, endpoint设置对接方的地址:
- 进入kubewps
- 执行脚本bashapps/{业务包名}/hook/customdefine/update_app_callback.sh{access_key} {secret_key} {endpoint}
示例:
access_key、secret_key节中获取到ak、sk,设置到对应access_key和secret_key参数中。
鉴权说明
所有接口调用都使用wps-4签名
证书授权
WPS文档中台须结合授权文件方可使用。当部署人员进行环境检查项通过之后,可申请试用授权。试用授权仅可用于最终用户测试验证,如已完成测试验证,请务必尽快完成采购下单流程,申请正式授权文件。
流程说明
在首次部署或授权需更新的情况下,按照以下流程进行授权操作:
- 执行以下命令获取企业唯一码, 获取的机器授权码通过英文分号;拼接。
执行kubewps,进入kubewps平台
执行wpsclitoolget-deploy-id获取机器码
- 提供授权相关信息(第一步执行获取的企业唯一码以及授权套数)进行授权证书文件申请。
- 授权文件申请成功后,进行授权证书导入。
- 授权导入成功后,等待1-2分钟,进行业务验证,业务能正常运行且未提示"未授权",即为正常。
- 业务正常运行后,可执行「获取licence接口」获取证书信息,在证书过期或不可用前,再次按照以上流程申请并导入授权证书。
授权导入
- 将证书文件(.lic)放到业务部署包的目录(kubewps/apps/部署包名.)下
- 执行kubewps容器,执行cdapps/部署包名.*目录下
- 执行bashhook/customdefine/import_lisense.sh *.lic