本文档由
石墨办公
提供。
石墨文档中台-开发文档
co1.8.20260830
co1.8.20260830
co1.8.20260630
全部文档
前端接口
后端接口
回调接口
全部文档
前端接口
后端接口
回调接口
co1.8.20260830
co1.8.20260830
co1.8.20260630
石墨官网
预约演示
co1.8.20260830
co1.8.20260830
co1.8.20260630
文件导入
复制页面
00. 概述
石墨文档中台能做什么?
石墨文档中台支持哪些格式?
三种典型的业务接入场景
01. 快速开始
基本概念
场景一:10 分钟创建预览文件
场景二:10 分钟创建协同编辑文件
02. 鉴权与安全
整体概述
签名凭证 Token
签名凭证 Signature
03. 文件预览
整体概述
如何预热预览缓存
如何防盗链
常见问题处理
04. 文件编辑
整体概述
协同文档权限设计
协同文件保存与更新机制
协同文件复制与删除
05. 文件导入导出
整体概述
常见问题处理
06. 石墨前端 API
整体概述
公共 API
公共处理方法
顶部栏定制 HeaderBars
编辑器 API
文档
文稿
表格
幻灯片
应用表格
表单
07. 石墨后端 API
整体概述
错误码说明
文件-预览 API
访问预览文件
创建文件预览缓存
文件-协同编辑文件管理 API
访问协同编辑文件
创建协同文件(新版带额外参数)
创建协同文件副本
删除协同文件
文件-导入导出 API
文件导入
文件导入说明
创建导入任务
POST
获取导入进度
POST
创建导入任务(旧版)
POST
获取导入进度(旧版)
POST
文件导出
文件导出流程
导出文件
获取导出进度
文件-文档文件(类 Markdown) API
获取文档中的评论列表
文件-文稿文件(Word) API
文稿书签说明
读取文稿书签内容
替换文稿书签内容
文件-表格文件(Excel) API
表格接口参数说明
获取表格内容
获取表格中的评论数
更新表格内容
追加表格内容
删除表格行
新增表格工作表
文件-获取额外信息 API
获取文件的纯文本内容
文件纯文本字数统计
获取文件的历史列表
获取文件的版本列表
获取文件内容中所有的 @ 人信息列表
还原文件历史版本
系统管理 API
用户席位管理
用户席位状态说明
获取用户列表和席位状态
激活用户席位
取消用户席位
批量设置用户席位
其他 API
上报事件
创建行为历史
推送文件内全部的用户
推送用户全部的 websocket 连接
08. 回调接口(您的应用需实现的接口)
整体概述
文件信息
文件权限说明
[重要] 获取文件元信息-协同文档
获取当前用户的文件列表
[重要] 获取文件元信息-预览文档
获取文件的协作者列表
获取文件元信息-协同文档自动任务(admin)
根据指定用户获取文件元信息-协同文档(admin)
获取接入方指定文件的完整访问地址
用户信息
批量获取用户信息(admin)
[重要] 获取当前用户信息
获取当前用户所在团队信息
获取指定用户信息
获取用户水印信息
获取用户部门路径
批量获取用户信息
团队和部门
特殊部门 ID 说明
获取团队下的成员列表
获取部门信息
获取部门的下级部门节点
获取部门下的成员分页列表
搜索功能
获取与文件相关的用户列表
获取与文件相关的文件 列表
按关键字搜索文件和用户列表
事件推送
整体概述
评论(Comment)
文档
添加评论
删除评论
结束评论
对于评论的回复评论
文稿
对于评论的回复评论
添加评论
更新评论
删除评论
表格
添加评论
删除评论
结束评论
对于评论的回复评论
幻灯片
添加评论
删除评论
结束评论
对于评论的回复评论
应用表格
添加评论
对于评论的回复评论
删除评论
讨论(Discussion)
文档
发送讨论消息
提及(MentionAt @ 人)
文稿
在评论中 at
在正文中 at
文档
在评论中 at
在讨论中 at
在正文中 at
表格
在评论中 at
在正文中 at
应用表格
在评论中 at
在正文中 at
日期提醒 (DateMention)
文稿
创建
修改
删除
文档
创建
修改
删除
表格
创建
修改
删除
文件内容更新 (FileContent)
文件内容更新
文档协作者协同状态变化 (Collaborator)
文档协作者协同状态变化
文件版本 (Revision)
版本
系统事件 (System)
系统事件
回调请求错误(实验性)
回调请求错误
09. 核心模型
你的应用如何设计文件数据模型?
你的应用如何设计通讯录模型?
你的应用系统如何设计文件权限模型?
您的应用如何设计应用(app)模型?
您的应用如何设计文件数据模型?
您的应用如何设计通讯录模型?
您的应用系统如何设计文件权限模型?
你的应用如何设计应用(app)模型?
10. 典型场景方案
云盘场景
IM 场景
示例代码仓库
11. 常见问题
文件预览或导入报错
文档预览如何做防盗链
复制粘贴、全屏操作不正常
文档内容何时保存
移动端不支持 blob 协议导致预览失败
@人员时如何直接跳转至对应锚点
访问接口提示 Signature
首次接入 SDK 报错
如何实现文档模板功能
如何实现文件重命名
如何通过接口修改文档内容
文件导入
复制页面
文件导入说明
概述
#
文件导入采用异步处理模式,分为两个步骤:
接口1-
创建导入任务
接口2-
轮询查询导入进度
详细流程
#
导入流程图
导入时序图
1
创建导入任务
1.
接入方调用
创建导入任务接口
,上传需要导入的文件
2.
系统接收文件后,创建异步导入任务
3.
接口立即返回唯一的
taskId
,用于后续查询进度
2
轮询查询进度
1.
接入方使用获得的
taskId
调用
查询导入进度接口
2.
系统返回当前任务的状态信息,包括:
status
:任务状态码(0表示正常,非0表示失败)
progress
:导入进度(0-100,100表示完成)
3
结果判断
根据接口返回的状态信息,进行以下判断:
情况1:导入成功
当
status == 0
且
progress == 100
时,表示文件导入成功
此时文件已完全导入系统,可以正常使用
情况2:导入进行中
当
status == 0
且
progress < 100
时,表示任务正在处理中
建议等待适当时间(如3-5秒)后重新调用查询接口
持续轮询直到任务完成或失败
情况3:导入失败
当
status != 0
时,表示任务执行失败
接入方需要处理错误,可根据错误码进行相应处理
如需重试,可重新发起导入任务
使用建议
1.
轮询间隔
:建议查询间隔不少于3秒,避免频繁请求
2.
超时处理
:建议设置合理的总超时时间,避免无限等待
3.
错误重试
:网络错误可重试查询,业务错误需要重新导入
4.
并发限制
:同一接入方建议控制并发导入任务数量
特别注意
文件ID
:导入、重新导入时必须使用不同的文件ID,石墨不支持对已存在的文件覆盖式导入
修改于
2026-08-25 08:24:49
上一页
删除协同文件
下一页
创建导入任务