文档比对API前端集成方式
从v7.3 FP4 hotfix5 开始，Filez 文档中台支持前端集成方式调用文档比对API。
描述：文档对比api用于对比两个内容相似的文字文档的差别。用户需要提供两个内容相似的文字文档。例如文档A和文档B，对比结果以html页面形式提供。html页面中展示原文档和对比文档，以及它们的差异。
使用方式：访问以下接口，将返回对比结果页面。其中docId和docIdB为业务系统中文档A和文档B的id。(docId为展示页面中的原文档，docIdB为展示页面中的比对文档)
http(s)://${zOffice_domain}/docs/app/driver-callback?repoId=${repoId}&docId=${docId}&docIdB=${docIdB}&action=compare&userinfo=${userInfo}&meta=${meta}&metaB=${metaB}&downloadUrl=${downloadUrl}&downloadUrlB=${downloadUrlB}¶ms=${params}&ts=${ts}&HMAC=${hmac}
注意：
- 文档比对API只有用户完成前端集成在线编辑对接后，才能调用。
- 相应的参数参考 文档中台-集成版三方前端集成接口说明
请求完整参数定义如下
| 参数名 | 是否必选 | 描述 |
|---|---|---|
| repoId | 是 | 第三方服务在zOffice中的唯一标识ID，第三方服务自行定义，需同时在管理控制台上设置。 |
| docId | 是 | 文档在第三方系统中的唯一ID，标识被对比的文档docA ID |
| docIdB | 是 | 文档在第三方系统中的唯一ID，标识对比文档 docB ID |
| action | 是 | 标识打开文档的行为，取值compare |
| userinfo | 是 | 标识进行操作的用户信息，是base64编码的JSON字符串。base64(JSON.stringify(userinfoObj))。拼接到URL之前需要使用encodeURIComponent编码 |
| meta | 是 | 标识docA文档的元信息，是base64编码的JSON字符串。base64(JSON.stringify(metaObj))。拼接到URL之前需要使用encodeURIComponent编码 |
| metaB | 是 | 标识docB文档的元信息，是base64编码的JSON字符串。base64(JSON.stringify(metaObj))。拼接到URL之前需要使用encodeURIComponent编码 |
| downloadUrl | 是 | 下载docA文件流的地址。对应的URL地址不可以使用encodeURIComponent编码，请勿包含请求参数，需要传递的请求参数通过params传递。 downloadUrl 与管理控制台中该应用配置的接口地址前缀的host必须一致。host 包含hostname和端口。如果downloadUrl中的host 不带端口，相关配置也不要带端口，即使是缺省端口 |
| downloadUrlB | 是 | 下载docB文件流的地址。对应的URL地址不可以使用encodeURIComponent编码，请勿包含请求参数，需要传递的请求参数通过params传递。 downloadUrl 与管理控制台中该应用配置的接口地址前缀的host必须一致。host 包含hostname和端口。如果downloadUrl中的host 不带端口，相关配置也不要带端口，即使是缺省端口 |
| params | 否 | 需要回传的信息，格式key=value;key2=value2。 如果请求downloadUrl和uploadUrl时，三方系统有权限验证，请务必在params中传递相关身份信息，否则会导致请求失败。 |
| ts | 是 | URL生成的时间戳，精度毫秒 |
| HMAC | 是 | 请求URL加盐哈希值，用于验证请求地址是否被篡改 |
大小边界
当前仅支持doc /docx 文档，大小不超过50M