讯飞文档开发者中心

# 快速开始

# 服务部署

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

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

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

# 创建应用

使用拥有管理员权限的账号登录讯飞文档商业版，点击右上角头像，选择并进入企业管理后台，选择左侧的应用管理菜单。

点击创建应用，填入基本信息。

创建应用

如果已经创建了，可以直接在相应的应用上进行查看或者编辑操作。

应用信息

这里，我们需要拿到 AccessKey 和 AccessSecret，用于后续访问接口。

# 访问接口

通过访问接口，我们可以在指定用户的空间下，创建或管理文档。这里以创建文档为例。

# 授权管理

访问接口需要授权，授权分为应用级授权和用户级授权。应用级授权权限较大，可以操作所有用户的数据，用户级授权只可操作该用户本身的数据。业务方可根据具体的业务场景，申请不同的授权。

  1. 生成应用访问凭证 (opens new window)
  2. 生成用户访问凭证 (opens new window)

# 创建用户

商业版 API 和商业版应用的数据是互通的，API 操作的用户也商业版应用的用户也是一一对应的。不同之处在于，API 通过 appUserId 作为唯一标识，应用通过 uid 作为唯一标识。这两者的区别，可以参考 AppUserId 和 uid。

如果调用 API 前，用户已经注册登录了商业版应用，则需要调用 绑定用户 (opens new window) 接口来进行绑定。如果未登录，可以调用 添加用户 (opens new window) 接口来注册并绑定用户。添加用户接口支持批量操作。

# 创建文档

使用前两步获取到的访问凭证和 appUserId，调用 创建轻文档 (opens new window) 接口，创建一个轻文档。

创建成功后，可以通过 查询文件列表 (opens new window) 接口查看刚才创建的文档是否存在于文件列表，也可以直接登录讯飞文档商业版应用直接在线查看。

# 前端集成

讯飞文档商业版托管了一个在线的编辑页面服务，业务方可以通过传入访问凭证（token）后直接使用。

URL 形式为：${BASE_URL}/sdk-app.html?fid=${fid}&token=${token}。

其中：

  • BASE_URL 为服务基础 URL，如：https://demo.iflydocs.com/
  • fid 为文档 ID，如：d7S
  • token 为访问凭证，也就是访问接口获取到的 access_token。

一个完整的 URL 如下：

https://demo.iflydocs.com/i/sdk-app.html?fid=d8S&token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjIjoiRU5URVJQUklTRV9BUFBMSUNBVElPTl9DTElFTlQiLCJzIjoxNzAyODgxODgzMDI1LCJ0IjoiQSIsInUiOiJhcHBfMTY4NDg0MjU3MzcwM18xNzAyODgxODIxMjU4IiwiaXNzIjoiYXV0aDAiLCJleHAiOjE3MDI5NjgyODN9.1VMcUR-Y26CVVXlhaEYUOqjTF7FPyb_6RrZcTz0K7PI

通过上面的链接即可直接访问编辑页面。通常，我们更建议在业务方自己的应用中通过 <iframe> 标签进行嵌入。

<body>
  <iframe id="editor" frameborder="0" width="1024" height="768"></iframe>
  <script>
    document.getElementById('editor').src = `${EDIT_URL}`
  </script>
</body>

# 官方示例

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

← 接口说明 →