跳到主要内容
2023-12-13 02:52 更新版本:latest

FAQ

咨询问题

Q:石墨文档中台支持导入什么格式的文档?

A: 请参考产品介绍中的 文件导入支持的格式

Q:石墨文档中台是否必须要认证以后才能体验相关核心功能?

A: 是的,必须上传营业执照,认证合法的企业资质才能体验。

Q:石墨文档中台最多可以创建多少个应用?

A: 测试应用为 1 个,正式应用不限数量。

使用问题

Q:石墨文档中台有导出 ofd 文件的接口吗?

A: 目前不支持导出 ofd 格式。支持导出的文件格式请参考 文件导出支持的格式

Q:石墨文档中台如何基于我的文件模板,新建文件?

A: 石墨文档中台目前不提供模板,可以新建一个文件作为模板,然后再创建副本。

Q:石墨文档中台前端 SDK 有 API 文档吗?

A: 石墨提供了丰富的前端 API,使用文档正在编写中,敬请期待。

Q:石墨文档中台如何查看只读状态下的在线文档的历史记录?

A: 请参考文档 获取历史信息

Q:石墨文档中台插入书签后,书签内容能否替换为表格?

A: 石墨传统文档支持书签替换功能,可替换为纯文本或整篇传统文档,详细内容请参考 替换书签内容

Q:石墨文档中台 API 如何设置只读和编辑?

A: 回调接口控制当前用户权限,请参考 文件权限说明 文档。

Q:石墨文档中台在哪里可以获取文档 URL,便于接入方自定义参数?

A: 文档的 url 由接入方自己决定,只需要实例化 js-sdk 即可将石墨编辑器嵌入您的页面中。

Q:石墨文档中台为什么打开的文档是只读模式?

A: 辛苦检查以下内容:

  1. 检查回调接口的权限字段配置
  2. 检查前端 js-sdk 接入时更新签名的策略,签名过期也会导致无法编辑

Q:石墨文档中台如何设置书签?

A: 传统文档支持用户手动插入书签。

Q:石墨文档中台是否有导出 pdf 的功能有服务端接口调用的方式?

A: 请参考 导出文件 文档。

Q:在石墨文档中台如何获取 excel 表格数据?

A: 请参考 获取表格内容 文档。

Q:石墨文档中台使用时,预览文档和协同文档用的同一个元数据回调接口,怎么确定它是预览功能还是协同功能呢?

A: 石墨服务开放平台有有两种文件类型:【预览文档】和【协同文档】且每种文件类型都是固定不变的。

其中【协同文档】既支持预览访问,也支持编辑访问,但【预览文档】只支持预览访问。所以当生成 fileId 的时候,这个文件是预览还是协同,就已经确定了。

Q:创建了协同文档,但是无法打开预览页面,如何处理?

A: 需要确认以下信息:

1.确认文件元信息回调接口是否缺少字段

2.确认创建协同文档时填的 type 和回调接口中的 type 是否一致,例如 document 和 documentPro 就是两种类型

{
"id": "ba13551165cc5066",
"name": "示例文档",
"type": "document",
"permissions": {
"commentable": true,
"editable": true,
"readable": true,
"copyable": true,
"exportable": true
},
"views": 100,
"creatorId": "1",
"createdAt": "2021-08-01T00:00:00Z", // UTC 时间,0 时区,在北京时间基础上减 8 小时
"updatedAt": "2021-08-02T00:00:00Z", // UTC 时间,0 时区,在北京时间基础上减 8 小时
"teamGuid": "123" // 接入方文件所属团队 ID
}

Q:使用石墨文档时,如何保存文档保存?

A: 文档不用手动保存,在编辑的过程中文档会实时自动保存。

Q:使用石墨文档时,如何保存文件的最新版本?

A: 通过 /events 回调接口的 文件内容更新 实现。

Q:石墨文档中台升级时,前端需要对接升级吗?

A: 建议使用最新的 shimo-js-sdk,具体操作请参考文档 石墨 JS-SDK 安装

Q:用户在获取 license 信息以及修改回调地址时,显示返回 400,该如何处理?

A: 请参考以下步骤进行操作:

  1. 首先排查 signature 是否计算正确,是否过期
  2. 然后检查 signature 过期时间是否设置过长(大于 5 分钟),获取 App 详情接口是严格接口,过期时间不能大于 5 分钟。

Q:石墨文档中台如何把本地文件通过在线编辑器打开?

A: 可以使用 导入文件 接口,将本地文件导入至文档中台后,对接 js-sdk,即可在页面中在线访问文档。

Q:石墨文档中台如何获取 file_id?

A: file_id 由接入方自行定义,传入石墨文档中台。

Q:石墨文档中台是否支持水印功能?

A: 支持水印功能,接入方实现 获取用户水印信息 接口后,可展示水印。

Q:石墨文档中台在那里获取文件下载地址?

A: 可以调用 导出文件 接口创建导出任务,然后通过 获取导出进度 接口获取文件下载地址。

Q:文档中附件上传的文件是存在石墨服务器还是接入方服务器? A: 附件上传的文件在石墨服务器。

Q:文档中引用的第三方文件是存在石墨服务器还是接入方服务器? A: 引用的第三方文件在第三方服务器。

Q:文档中台提供文件夹、文件列表、桌面、云盘界面等功能吗? A: 文档中台不提供这些功能,仅提供对文档的预览和协同编辑功能。 文件夹、文件列表、桌面、云盘界面等功能都需要接入方根据自己的场景来实现,只有在打开文件的时候才会用到石墨文档中台。

Q:怎么修改文档标题? A: 石墨文档中台不保存文档标题,文档标题通过调用回调接口,从接入方获取。 接入方可以通过监听石墨编辑器内的标题变化来通知自己的服务端修改文件名称:

const editor = sdk.getEditor();
editor.on("titleChange", (newTitle) => {
console.log(newTitle);
});

Q:接入方前端监听这个事件获取修改标题的行为,然后通知自己的后端修改这个文件名。 A: 石墨 sdk 不保存文件名称,所以修改标题本质是接入方修改回调接口中的文件名。

Q:创建文档副本时,操作的用户需要什么权限? A: 有 readable 权限就可以。

Q:我的应用有多种客户端,例如安卓、iOS、electron 等,有对应每个平台的对接文档吗? A: 没有对应不同平台的对接文档。石墨文档中台提供的能力都基于 web,并且支持 H5,在这些客户端下对接的方式是一致的。

Q:我的文件内容在石墨系统中是明文存储的吗? A: 文件的原始内容在石墨系统中,都是经过了特殊编码后存储的,不具有可读性。