1. 09. 核心模型
石墨文档中台-开发文档
  • 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. 09. 核心模型

你的应用系统如何设计文件权限模型?

场景一:审批流协作#

示例链路:
-> 用户 A 创建并发起协作文档
-> 用户 B 参与编辑
-> 用户 C 仅浏览并有评论 / 批注权限
-> 审批完成后,文件外发给用户 D,自助下载 / 在线预览

一、实现方案#

在这个场景中,权限判断由业务系统决定,石墨根据业务系统在文件元信息回调中返回的权限字段执行页面能力控制。
核心原则:
1.
业务系统是权限源。
2.
石墨只根据回调结果控制读、写、评论、复制、导出等能力。

二、最小对象模型#

该场景只需要保留 4 类核心对象。
对象含义
user租户内用户身份,对接石墨时使用 user.id
approval_document业务系统中的审批文档记录
approval_participant审批文档参与人及其角色

2.1 审批文档表#

status 建议最小化为:
状态含义
DRAFT草稿,创建人可编辑
IN_REVIEW审批中,编辑者可协作,审阅者可评论
APPROVED审批完成,内部用户通常只读,允许外发
REJECTED审批驳回,可回到编辑状态
CANCELLED已取消,不允许继续访问或编辑

2.2 审批参与人表#

role 建议最小化为:
角色对应用户含义
OWNER用户 A创建人 / 发起人
EDITOR用户 B协作编辑人
COMMENTER用户 C审阅人,可浏览和评论
VIEWER可选只读用户

三、各角色权限设计#

用户角色打开编辑评论 / 批注复制导出 / 下载管理
用户 AOWNER允许允许允许可配置可配置允许
用户 BEDITOR允许允许允许可配置不建议不允许
用户 CCOMMENTER允许不允许允许不建议不建议不允许
用户 D外部用户不允许不允许不允许不允许不允许不允许
审批中建议不要允许外部下载,除非业务明确需要。

四、石墨回调权限字段映射#

业务系统内部可以使用 role + status 计算权限,最终在文件元信息回调中返回石墨需要的能力字段。
常用字段:
字段含义
readable是否允许打开文档或预览文件
editable是否允许编辑协同文档
commentable是否允许评论 / 批注
copyable是否允许复制内容
exportable是否允许导出 / 下载
manageable是否允许管理类操作

4.1 审批中示例#

用户 B 作为协作编辑人访问审批中文档:
{
  "readable": true,
  "editable": true,
  "commentable": true,
  "copyable": false,
  "exportable": false,
  "manageable": false
}
用户 C 作为审阅人访问审批中文档:
{
  "readable": true,
  "editable": false,
  "commentable": true,
  "copyable": false,
  "exportable": false,
  "manageable": false
}

4.2 审批完成后示例#

审批完成后,用户 B 再次访问同一份文档:
{
  "readable": true,
  "editable": false,
  "commentable": false,
  "copyable": false,
  "exportable": true,
  "manageable": false
}
外发用户 D 在线预览:
{
  "readable": true,
  "editable": false,
  "commentable": false,
  "copyable": false,
  "exportable": true,
  "manageable": false
}
如果外发链接只允许在线预览,不允许下载,则返回:
{
  "readable": true,
  "editable": false,
  "commentable": false,
  "copyable": false,
  "exportable": false,
  "manageable": false
}

五、关键边界规则#

审批完成如何实现任何人不能编辑文档的效果?#

创建审批、审批进行过程中,文档点击入口可以通过石墨文档中台前端 JSSDK connect() 访问,这样可以根据使用用户的权限来实现可编辑、可评论、可预览的功能。
审批完成后,文档需要保持静止不能做任何更新(即使有编辑权限也不行)。此时你的系统的文档点击入口可以调整为石墨文档中台预览入口,即 /page/iframe 路由即可。
修改于 2026-06-22 02:43:30
上一页
你的应用如何设计通讯录模型?
下一页
云盘场景
Built with