开发工具
  1. 文档专区
开发工具
  • 文档专区
    • 10 分钟创建协同文档
    • 签名续期说明
    • 签名方式
    • 用户席位说明
  • 石墨API 接口
    • App 管理
      • 获取 App 详情
      • 更新 App 回调地址
      • 获取用户列表和席位状态
      • 激活用户席位​
      • 取消用户席位​
      • 批量设置用户席位
    • 文档创建删除
      • 创建协同文档
      • 创建协同文档副本
      • 删除协同文档
      • 访问预览文档
      • 创建预览文档
    • 文档导入导出
      • 导入文件
      • 获取导入进度
      • 导出文件
      • 获取导出进度
      • 导出应用表格为Excel
    • 文档操作
      • 通用
        • 获取文件纯文本内容
        • 文件纯文本字数统计
        • 获取历史列表
        • 获取版本列表
        • 获取文档内容中所有的at人信息列表
      • 表格(Excel)
        • 获取表格内容
        • 获取文档中的评论数
        • 更新表格内容
        • 追加表格内容
        • 删除表格行
        • 新增表格工作表
      • 传统文档(Word)
        • 读取传统文档书签内容
        • 替换传统文档书签内容
  • 接入方实现接口(回调接口)
    • 文件信息
      • 获取文件元信息-协同文档
      • 获取文件元信息-预览文档
      • 获取当前用户的文件列表
      • 获取文件的协作者列表
      • 获取接入方指定文件的完整访问地址
      • 获取文件元信息-协同文档自动任务
      • 根据指定用户获取文件元信息-协同文档
    • 用户信息
      • 获取当前用户信息
      • 获取当前用户所在团队信息
      • 获取指定用户信息
      • 获取用户水印信息
      • 获取用户部门路径
      • 批量获取用户信息
    • 团队和部门
      • 获取团队下的成员列表
      • 获取部门信息
      • 获取部门的下级部门节点
      • 获取部门下的成员分页列表
    • 搜索功能
      • 获取与文件相关的用户列表
      • 获取与文件相关的文件列表
      • 按关键字搜索文件和用户列表
    • 消息推送
      • 评论
        • 轻文档
          • 添加评论
          • 删除评论
          • 结束评论
        • 表格
          • 添加评论
          • 删除评论
          • 结束评论
        • 传统文档
          • 添加评论
          • 删除评论
          • 更新评论
        • 幻灯片
          • 添加评论
          • 删除评论
          • 结束评论
        • 应用表格
          • 添加评论
          • 对于评论的回复评论
          • 删除评论
      • 讨论(Discussion)
        • 轻文档
          • 发送讨论消息
      • 提及(MentionAt @ 人)
        • 轻文档
          • 在评论中 at
          • 在讨论中 at
          • 在正文中 at
        • 表格
          • 在评论中 at
          • 在正文中 at
        • 传统文档
          • 在评论中 at
          • 在正文中 at
        • 应用表格
          • 在评论中 at
          • 在正文中 at
      • 日期提醒 (DateMention)
        • 轻文档
          • 创建
          • 修改
          • 删除
        • 表格
          • 创建
          • 修改
          • 删除
        • 传统文档
          • 创建
          • 修改
          • 删除
      • 文件内容更新 (FileContent)
        • 文件内容更新
      • 文档协作者协同状态变化 (Collaborator)
        • 文档协作者协同状态变化
      • 版本 (Revision)
        • 版本
      • 系统事件 (System)
        • 系统事件
      • (实验性) 回调请求错误
        • 回调请求错误
  1. 文档专区

签名方式

使用 App ID 和 App Secret 签名,用于石墨服务器验证接入方的请求合法性。
签名后的结果(即 signature 的值)为 JSON Web Token(简称为 JWT)格式字符串,其结构包括 Header、Payload、Signature 三个部分。
JWT 通常形式为 xxxxx.yyyyy.zzzzz
Header 部分
默认包含的字段:alg 、typ
alg 表示签名算法,通常默认为 HS256
typ 标识 Token 类型,JSON Web Token 的类型默认为 JWT
添加 kid 字段,值为 App ID
Payload 部分
仅添加 exp 字段即可,值为 JWT 的过期时间的秒数 ,例如 1612411882 (如当前时间的秒数值比 exp 字段的值要小,说明还没有到达过期时间,此签名不会被判断为失效)
当请求 /admin 相关 API 时,会额外增加 fileId 信息
签名前的数据结构:
Header
{
  "alg": "HS256", // 默认字段
  "typ": "JWT", // 默认字段
  "kid": "your AppId"
}
Payload
{
  "exp": 1612411882
}
Payload 参数
字段名字段名值示例必选说明
expnumber1612411882是签名的过期时间称
scopestringlicense否用于访问某些限定 scope 的 API,详细信息请参考对应的 API 说明
Java 示例:
以 https://github.com/auth0/java-jwt 为例
修改于 2024-03-07 08:39:16
上一页
签名续期说明
下一页
用户席位说明
Built with