跳到主要内容

重要术语

在和每个应用集成前，业务系统的集成人员，需要确定：业务系统id、业务系统回调context、token的名字。

文档ID (docId)​

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

调用示例：

http(s)://${zOffice_domain}/docs/app/${app-id}/${docId}/${action}/content

重要说明：

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

业务系统ID (appId/repoId)​

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

调用示例：

http(s)://${zOffice_domain}/docs/app/${app-id}/${docId}/${action}/content

说明：

  • url中的${app-id}就是业务系统的id
  • 这个id需要在Filez文档中台配置

三方业务系统回调Context​

三方业务系统需要实现约定好的回调API，其回调地址的context需要在Filez文档中台配置。

示例：

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

（注意：这个url没有最后的'/'）

API调用示例： zOffice 发出的get content API(docId = 12168237)，即业务系统实现的文件下载回调API是：

http://my.integration.com/zoffice/files/12168237/content

三方Token名​

如果业务系统希望在调用zOffice服务入口地址时，在url query parameter中带上token，比如 (?zdocs_access_token=xxxxx)。这个token是三方token。它的名字可以在Filez文档中台配置。

重要限制：

  • token的值不可以是中文
  • 例如：http(s)://oa.demo.com/docs/app/thirdparty-rest/123/edit/content?zdocs_access_token=中文 这样不行
  • 因为zOffice会把url上的token通过Cookie发给三方系统，Cookie不可以设置中文的值
  • 三方在调用zOffice时，如果token是中文，需要编码成Cookie可以识别的字符串

三方标准集成配置​

  1. 登录管理控制台（docs/app/admin），默认密码为admin。  

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

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

  4. 填写应用信息：三方应用id和三方应用接口地址为必填项，其他选填。三方应用接口token名称默认值为zdocs_access_token。 点击下方添加应用，可同时添加多个应用集成。

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

配置说明

集成配置完成后，请确保所有API接口都能正常访问，建议先在测试环境验证。

最后于 更新