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

获取文件元信息-预览文档

GET
{endpoint_url}/files/{fileId}
获取基本信息、下载地址,预览文件时会请求此接口。
说明
此接口地址与 获取文件元信息-协同文档 相同,但返回结果不同;可能需要接入方自行区分文件是石墨协同文档还是普通文件。
说明
请求下载时接入方无法返回 Content-Type 以及 Content-Disposition 信息用于石墨文档中台识别文件类型,此时通过元信息中返回的 ext 字段告知石墨文档中台此文件的扩展名。例如 docx 识别为 Word 文件。
ext 字段不带 . ,例如文件为 测试文件.docx ,应返回 docx。
出于安全性考虑,2021-12-01 之后开始,预览时获取文件信息需要返回 permissions 信息用于验证当前用户是否具有相应权限。
注:石墨服务器会下载downloadUrl中的文件进行解析。可能需要设置指定的 Header 供石墨来选择以何种方式解析。更多细节可以参考 Header 要求。

请求参数

Path 参数
endpoint_url
string 
必需
示例值:
{{endpoint_url}}
fileId
string 
必需
Header 参数
X-Shimo-Token
string 
必需
用于接入方对本次请求鉴权

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET '/files/' \
--header 'X-Shimo-Token;'

返回响应

🟢200成功
application/json
Body
id
string 
必需
接入方系统中的文件 ID
name
string 
文件标题
必需
type
string 
必需
目前使用 file 表示第三方文件类型
permissions
object 
必需
请参考 文件权限说明
readable
boolean 
必需
downloadUrl
string 
必需
用于预览 Office 文件时下载文件内容
ext
string 
必需
当石墨请求下载地址 (downloadUrl) 返回的 HTTP Response Header 中 Content-Type 或 Content-Disposition 接入方未返回可识别的信息时,此字段用于标识此文件的扩展名。不需要带" .",若文件为测试文件.docx ,则应传 docx,若返回 .docx 可能识别失败。
示例
{
  "id": "ba13551165cc5066",
  "name": "示例文档.docx",
  "type": "file",
  "permissions": {
    "readable": true
  },
  "downloadUrl": "http://example.com/download/test.docx",
  "ext": "docx"
}
上一页
获取文件元信息-协同文档
下一页
获取当前用户的文件列表
Built with