快速开始

1. 前期准备

在开始集成前，请先在管理控制台配置业务系统信息（业务系统 repoId/appId、回调 context、接口 token 名称等），详见：前期准备。
建议同时阅读：重要术语，确保 docId、repoId、context 等概念与约束一致。

2. 实现回调接口

预览文档（view）至少需要实现以下接口：

编辑文档（edit）至少需要在上述基础上额外实现：

保存文件API

回调地址格式说明（以获取文件为例）

获取文件接口地址格式为：{context}/{docId}/content
其中：

context：管理控制台中配置的回调 context（通常为你的业务系统接口前缀）
docId：业务系统内唯一标识文件的 ID（需自行生成并保证稳定唯一）

例如 context 配置为 http://demo:8000/context，则获取文件接口为：
http://demo:8000/context/{docId}/content

接口响应为文件流，建议直接在浏览器访问该 URL（带上必要鉴权）验证能否正确下载文件。

3. 访问在线文档页面

在线文档页面的访问地址格式为：

http://{zofficehost}:8001/docs/app/{repoId}/{docId}/edit/content?{token_name}={token}

其中：

repoId：管理控制台中配置的三方应用 ID
docId：业务系统内的文档 ID
token_name：三方应用接口 token 名称，默认值为 zdocs_access_token
token：访问 token（即使回调接口不校验 token，也必须提供一个占位 token，否则会导致请求失败）

token 传递方式

你可以选择：

直接在 URL query 中携带 token_name/token
或者将 token 放入 Cookie 中
还支持放在请求体中，详情见安全

文档中台在回调业务系统接口时，会将该 token 放入 Cookie 中传递。

你可以选择直接新标签页访问，也可以通过 iframe 嵌入到业务系统页面中。

下面是get请求访问文档中台的iframe示例，想使用post请求参考安全。

iframe 示例

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <style type="text/css">
    iframe {
        width: 100%;
        height: 100%;
        position: absolute;
        top: 0;
        left: 0;
        right: 0;
        bottom: 0;
        margin: 0;
        border: none;
        display: block;
    }
    body {
        margin: 0;
        padding: 0;
    }
  </style>
</head>
<body>
<div>
  <iframe
    id="integration-frame"
    src="http://zofficehost:8001/docs/app/repoId/docId/edit/content?token_name=token"
    allowfullscreen="true"
    allow="fullscreen *">
  </iframe>
</div>
</body>
</html>

1. 前期准备​

2. 实现回调接口​

回调地址格式说明（以获取文件为例）​

3. 访问在线文档页面​

token 传递方式​

iframe 示例​