本文档由
石墨办公
提供。
石墨文档中台-开发文档
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
文件导入
文件导入说明
创建导入任务
获取导入进度
创建导入任务(旧版)
获取导入进度(旧版)
文件导出
文件导出流程
导出文件
获取导出进度
文件-文档文件(类 Markdown) API
获取文档中的评论列表
文件-文稿文件(Word) API
文稿书签说明
读取文稿书签内容
替换文稿书签内容
文件-表格文件(Excel) API
表格接口参数说明
获取表格内容
获取表格中的评论数
更新表格内容
追加表格内容
删除表格行
新增表格工作表
文件-获取额外信息 API
获取文件的纯文本内容
文件纯文本字数统计
获取文件的历史列表
获取文件的版本列表
获取文件内容中所有的 @ 人信息列表
还原文件历史版本
系统管理 API
用户席位管理
用户席位状态说明
获取用户列表和席位状态
GET
激活用户席位
POST
取消用户席位
POST
批量设置用户席位
POST
其他 API
上报事件
创建行为历史
推送文件内全部的用户
推送用户全部的 websocket 连接
08. 回调接口(您的应用需实现的接口)
整体概述
文件信息
文件权限说明
[重要] 获取文件元信息-协同文档
获取当前用户的文件列表
[重要] 获取文件元信息-预览文档
获取文件的协作者列表
获取文件元信息-协同文档自动任务(admin)
根据指定用户获取文件元信息-协同文档(admin)
获取接入方指定文件的完整访问地址
用户信息
批量获取用户信息(admin)
[重要] 获取当前用户信息
获取当前用户所在团队信息
获取指定用户信息
获取用户水印信息
获取用户部门路径
批量获取用户信息
团队和部门
特殊部门 ID 说明
获取团队下的成员列表
获取部门信息
获取部门的下级部门节点
获取部门下的成员分页列表
搜索功能
获取与文件相关的用户列表
获取与文件相关的文件列表
按关键字搜索文件和用户列表
事件推送
整体概述
评论(Comment)