1. 00. 概述
石墨文档中台-开发文档
  • 1. 适用范围
  • 00. 概述
    • 石墨文档中台能做什么?
    • 三种典型的业务接入场景
    • 石墨文档中台支持哪些格式?
  • 01. 快速开始
    • 基本概念
    • 场景一:10 分钟创建预览文件
    • 场景二:10 分钟创建协同编辑文件
  • 02. 鉴权与安全
    • 整体概述
    • 签名凭证 Token
    • 签名凭证 Signature
  • 03. 文件预览
    • 整体概述
    • 如何预热预览缓存
    • 如何防盗链
    • 常见问题处理
  • 04. 文件编辑
    • 整体概述
    • 协同文档权限设计
    • 协同文件保存与更新机制
    • 协同文件复制与删除
  • 05. 文件导入导出
    • 整体概述
    • 常见问题处理
  • 06. 石墨前端 API
    • 整体概述
    • 公共 API
      • 公共处理方法
      • 顶部栏定制 HeaderBars
    • 编辑器 API
      • 轻文档
      • 传统文档
      • 表格
      • 幻灯片
      • 表单
      • 应用表格
  • 07. 石墨后端 API
    • 整体概述
    • 错误码说明
    • 文件-预览 API
      • 访问预览文件
      • 创建文件预览缓存
    • 文件-协同编辑文件管理 API
      • 访问协同编辑文件
      • 创建协同文件
      • 创建协同文件副本
      • 删除协同文件
    • 文件-导入导出 API
      • 文件导入
        • 文件导入说明
        • 创建导入任务
        • 获取导入进度
        • 创建导入任务(旧版)
        • 获取导入进度(旧版)
      • 文件导出
        • 文件导出流程
        • 创建导出任务
        • 获取导出进度
    • 文件-表格文件(Excel) API
      • 表格接口参数说明
      • 获取表格内容
      • 获取表格中的评论数
      • 更新表格内容
      • 追加表格内容
      • 删除表格行
      • 新增表格工作表
    • 文件-文稿文件(Word) API
      • 文稿书签说明
      • 读取文稿书签内容
      • 替换文稿书签内容
    • 文件-文档文件(类 Markdown) API
      • 获取文档中的评论列表
    • 文件-应用表格文件(多维表格)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)模型?
    • 你的应用如何设计文件数据模型?
    • 你的应用如何设计通讯录模型?
    • 你的应用系统如何设计文件权限模型?
  • 10. 典型场景方案
    • 云盘场景
    • IM 场景
    • 示例代码仓库
  • 11. 常见问题
    • 访问接口提示 Signature
    • 文件预览或导入报错
    • 首次接入 SDK 报错
    • 文档预览如何做防盗链
    • 复制粘贴、全屏操作不正常
    • 如何实现文档模板功能
    • 文档内容何时保存
    • 移动端不支持 blob 协议导致预览失败
    • 如何实现文件重命名
    • 如何通过接口修改文档内容
    • @人员时如何直接跳转至对应锚点
  1. 00. 概述

石墨文档中台能做什么?

石墨文档中台,将石墨深耕多年的文档处理和协同编辑能力开放出来,能够方便的集成到数字化业务系统中,为您的系统快速构建文档处理能力。接入方式类似程序开发中的 SDK 接入,因此石墨文档中台又称石墨 WebOffice SDK。
你可以把石墨文档中台嵌入到的业务系统里。用户不需要离开你的产品,就可以完成文档编辑、Office 文件预览、文档导入导出、文档内容读写、创建查看评论等操作。
你可以把它理解为一套“文档能力底座”:你的业务系统负责用户、文件、权限相关的业务流程,石墨文档中台负责文档编辑器、预览渲染、格式处理和文档协作。

一、石墨文档中台有哪些能力?#

Word, Excel, PPT 文件的预览及协同编辑能力
石墨轻文档、应用表格、表单的协同编辑能力
基于 Web 集成,支持跨平台使用
在线编辑预览、多人协作、实时保存
提供丰富的接口,支撑强大的二次开发能力
其他更广泛的 【格式支持】

二、石墨文档中台的产品优势#

2.1 多种场景,灵活适用#

适用于 OA、IM、知识库等多种典型应用场景
支持桌面端、移动端主流 Web 浏览器

2.2 功能强大,设计友好#

高度兼容 MS Office、WPS 等主流文件格式的在线预览和协同编辑
全面支持石墨办公六大套件,为您的业务系统提供丰富的选择

2.3 稳定可靠,安全可控#

完善的日志和监控,整体 SLA 达到 99.9%
可追溯的协同编辑记录、文件版本历史,单元格级别的权限控制

三、石墨文档中台适合哪些场景?#

云盘/网盘/ECM:用户在文件列表里直接预览、编辑、导出 Office 文档。
OA/审批/合同管理:多人在线修改合同、制度、报告,并保留评论和版本记录。
知识库/内容管理:把已有文档变成可在线阅读、检索、导出和协作的内容。
CRM/ERP/业务表格填报:在表格里读取、写入、追加或更新业务数据。
IM/协作工具:在聊天或项目空间中直接打开文档,并同步评论、@ 人和协作状态。

四、石墨文档中台的能力地图是什么?#

协同编辑:创建石墨协同文档,在网页里打开编辑器,支持多人实时编辑。
文件预览:把 docx、xlsx、pptx、pdf 等文件以只读方式嵌入到业务页面。
导入导出:把外部 Office 文件导入为协同文档,或把协同文档导出为指定格式。
内容操作:读取或写入文档、表格、评论、历史版本等内容。
回调集成:石墨通过回调向业务系统获取用户、文件、权限和组织信息。

五、你的业务系统接入时石墨文档中台时双方如何分工?#

你的业务系统:负责用户登录、文件列表、权限判断、业务数据存储、审计日志。
石墨文档中台:负责文档编辑器、预览渲染、协同处理、导入导出任务、JSSDK 能力。
双方通过你的业务系统后端服务实现的回调接口来进行数据的联通。
修改于 2026-07-03 06:10:42
上一页
1. 适用范围
下一页
三种典型的业务接入场景
Built with