# 快速开始

# 服务部署

参照部署包中的部署文档进行部署，或者直接使用官方提供的开发环境。

官方开发环境的 Base URL：https://testpoc.iflydocs.com/editor/

私有化环境下请替换成对应的 IP + 端口号。

# 服务端接入

服务端接入分为三步。一是配置appid和回调地址；二是实现文档中台的回调接口；三是实现业务逻辑，向业务前端提供可访问的接口，并在这些接口中调用文档中台的服务，获取文档编辑和预览能力。

# 配置 appid 和回调地址

试用官方的开发环境时，需联系讯飞文档中台的工作人员，将接入方服务端的访问地址告诉工作人员，文档中台的工作人员配置完成后分发appid与appSecret。

私有化部署时，访问服务的9068端口，进入/admin/index.html配置页面，点击新增appid即可生成appid和对应的appSecret，在新生成的appid上配置接入方服务端的访问地址。

注意

为了您的数据安全性，请妥善保存好appSecret切勿泄露给无关人员！

# 实现回调接口

参照[回调接口]的说明，实现获取文件元数据、获取用户信息、文件回存等接口。

# 实现业务逻辑

新建或者在现有业务服务中，实现文档创建、修改、删除等业务功能，向前端提供相应接口供使用。文档中台相关使用的接口，请参考接口说明。

# 前端接入

接入方前端接入文档中台首先需要调用中台文件编辑接口，获取编辑器的依赖和配置信息，加载文件编辑页面，具体步骤如下：

# 添加编辑页面挂载容器

注意事项：容器 id 为'iframeEditor'的 div，为编辑器渲染的位置，建议为其父容器设置高度，否则可能会导致编辑页面的内容区域渲染不出来。

<div id="iframeEditor"></div>

# 调用接口获取 URL

调用业务服务的接口，获取编辑页面的 baseURL,可以通过接口'/fileList/getUrl'获取，接口参数以及返回结果字段说明请参考服务端接口说明。

# 引入 JS-SDK 并初始化

前端接入文档中台，首先需要调用中台文件编辑接口，获取编辑器的依赖和配置信息，加载文件编辑页面。为了简化客户接入，一系列接入步骤已被封装到 sdk.js 文件中，用户可通过引入 sdk.js 文件,该文件需要安装 axios 和 crypto-js。在项目中引入 sdk.js 文件，调用 sdk.config()函数可以快速初始化编辑器。注意,fid 为文件对应的 fid,其他参数,如 appId 和 APPSECRET 需要联系服务端进行申请。提示：该 sdk.js 文件在前端接入 demo 实例中，可以联系商务获取 demo 源代码。

import sdk from './sdk'
sdk.config({
  appId: 'xxxxxx',
  APPSECRET: 'xxxxxx', //appId
  fid: 'xxxxxx', // 文档对应的fid
  token: 'xxxxxx', // token
  baseURL: 'xxxxxx', // 中台能力地址
})

# 完整流程

以创建新文档文档并开始编辑为例：

用户点击创建文档按钮。
前端访问业务服务的创建文档接口；
业务服务创建一个空文档，对于 Office 文档，直接从空文档或者其他模块拷贝一份即可；
业务服务访问文档中台的文档编辑接口；
文档中台向业务服务请求获取文件元数据回调接口，并处理；
文档中台向业务服务返回包含编辑页面 URL 的信息；
业务服务向前端返回包含编辑页面 URL 的信息；
前端使用获取到的 URL 加载编辑页面；
用户开始编辑文档。

# 官方示例

我们提供了完整的示例供参考，请联系 docs@iflytek.com 获取。

← 概述接口说明 →