跳到主要内容

重要术语

在和每个应用集成前,业务系统的集成人员,需要确定:业务系统id、业务系统回调context。

文档ID (docId)

即docId。三方系统中的每一个文件都必须要有唯一的文档id。同一个文件,同一个id。三方系统请求在线编辑/预览服务时,需要指定编辑/预览的docId。

调用示例:

http(s)://${zOffice_domain}/docs/app/driver-callback?repoId=${repoId}&docId=${docId}&action=edit&downloadUrl=${downloadUrl}&uploadUrl=${uploadUrl}&params=${params}&ts=${ts}&HMAC=${hmac}

重要说明:

  • docId 是标识文件的Id,字符串类型
  • 不能有冒号:
  • 不能出现一个id对应不同的文件,一会是word文件,一会又变成pdf文件
  • 不能出现同一个文件,这次编辑是这个id,下次编辑又是另一个id

业务系统ID (appId/repoId)

三方系统请求在线编辑/预览服务时,需要指定当前请求的appId。

调用示例:

http(s)://${zOffice_domain}/docs/app/driver-callback?repoId=${repoId}&docId=${docId}&action=edit&downloadUrl=${downloadUrl}&uploadUrl=${uploadUrl}&params=${params}&ts=${ts}&HMAC=${hmac}

说明:

  • url query参数中的repoId=${repoId}就是业务系统的id
  • 这个id需要在Filez文档中台配置

三方业务系统回调Context

三方业务系统需要提供文件上传和下载地址,其地址的前缀(必须包括host)需要在Filez文档中台配置。

示例:

${context} = http://my.integration.com

(注意:这个url没有最后的'/')

这时请求url query 参数中的downloadUrl、uploadUrl的host必须和context中的host相同。例如

http(s)://${zOffice_domain}/docs/app/driver-callback?repoId=${repoId}&docId=${docId}&action=edit&downloadUrl=http://my.integration.com/files/123&uploadUrl=http://my.integration.com/files/update/123&params=${params}&ts=${ts}&HMAC=${hmac}

前端集成方式的配置

  1. 登录管理控制台(docs/app/admin),默认密码为admin。

管理控制台登录

管理控制台登录

  1. 点击集成应用进入集成配置页面

集成应用页面

  1. 点击新增应用进入新增应用页面

新增应用页面

  1. 填写应用信息:

三方应用id.和三方应用接口地址为必填项,其他选填。三方应用接口地址会约束downloadUrl的host。三方应用接口token名称默认值为zdocs_access_token(无需修改)。

点击开启前端集成填写集成加密密钥。可以用下列命令来产生:openssl rand -base64 64

该密钥需要同时保存到业务系统服务端。

应用配置

点击下方添加应用,可同时添加多个应用集成。

  1. 填写完毕后,点击保存。可以看到新的应用出现在应用列表中。

保存应用