WPS WebOffice 开放平台WPS WebOffice 开放平台 | 开发文档

深色模式

回调网关 ​

回调网关是 WebOffice 服务与接入方进行数据交互的总入口，调用行为发生在服务端之间，在配置具体的回调接口之前您需要先填写正确的回调网关地址才能进行后续的通讯。

回调接口会在用户预览或编辑在线文档时被调用，WebOffice 通过相关回调接口获取文件及用户信息。对接方需保证回调接口能够被 WebOffice 服务器访问到，即回调地址所在服务需要部署在公网。

回调寻址路径由两部分构成，分别为回调网关和回调接口：

回调网关：

回调网关目前支持 http 与 https 两种协议，支持以下两种范式：

范式一：scheme://host/path_prefix（/path_prefix 可以为空）

示例:

  • http://solution.wps.cn/dev/WebOffice
  • https://solution.wps.cn

范式二：scheme://ip:port/prefix (IP 必须为公网 IP 段)

示例：

  • http://117.78.0.2:8080/dev/WebOffice
  • http://117.78.0.2:8080

回调接口：

回调接口指接入方为 WebOffice 服务集群提供必要信息（文件元信息，用户信息等）的 API。

调用格式 ​

WebOffice 将通过回调网关拼接上 API 接口地址，然后以回调的方式请求对接方的这些接口。最终 WebOffice 集群将会向 回调网关+回调接口 发起请求。

以下为例子：

回调网关：https://solution.wps.cn/dev/WebOffice

接口：GET /v3/3rd/files/:file_id

文件 ID：1234567

最终请求地址：https://solution.wps.cn/dev/WebOffice/v3/3rd/files/1234567

提示

回调接口是在 WebOffice 服务端调用，不会暴露给前端用户。

配置流程 ​

第一步：进入回调配置 ​

进入控制台后，点击【应用管理】-【应用名称】-【回调配置】选项卡

应用列表

回调配置

第二步：配置回调网关 ​

假设网关地址为https://www.****.com:####，回调接口地址是 /v3/3rd/files/${file_id}，则完整的回调接口地址就是 https://www.****.com:####/v3/3rd/files/${file_id}。

第三步：接口调试 ​

针对每一个回调接口，可通过点击【调试】按钮，测试此接口能否被 WebOffice 服务器正常访问，以及接口返回的数据是否符合要求，您可以根据接口的调试信息逐步完善接口的逻辑。

接口调试

第四步：开启回调接口 ​

点击回调接口左侧的开关，即可开启此接口，开启后 WebOffice 服务将会自动启用该接口对应的功能，如果您的接口还未调试成功，可能会导致WebOffice文档加载失败、界面出现错误提示、浏览器控制台报错等情况。

接口开关

token、file_id 从哪获取？

token 由接入方自定义, WebOffice 将会在回调接口时通过 X-Weboffice-Token 的 Header 字段回传，可用于检查鉴权。

file_id可由数字、字母和下划线组成，但不能以下划线开头，它是由对接企业自己生成并管理，需要保证一个 file_id 对应一个文件，也对应一个文件的多个版本。