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

导入文件

POST
/sdk/v2/api/files/v1/import
导入文件过程是一个异步处理过程,接口请求成功仅代表导入服务收到并开始处理导入请求,实际是否成功需要轮询获取导入进度 接口查询导入任务是否完成。
导入支持的文件格式
石墨文件类型支持导入的文件类型
document.docx,.doc,.md,.txt
documentPro.docx,.doc,.wps
spreadsheet.xlsx,.xls,.csv, .xlsm
presentation.pptx,.ppt

请求参数

Query 参数
signature
string 
可选
示例值:
{{signature}}
token
string 
可选
示例值:
123123
Header 参数
X-Shimo-Signature
string 
必需
示例值:
{{signature}}
X-Shimo-Token
string 
必需
示例值:
{{token}}
Body 参数multipart/form-data
fileId
string 
必需
服务商文件的唯一 ID
示例值:
file-import-6
type
string 
需要导入的文件类型
必需
示例值:
document
file
file 
可选
需要导入的文件(如果不发送文件,就必须传fileUrl、fileName)
示例值:
file:///Users/luyang/Documents/TempDoc/shimo_test.docx
fileUrl
string 
可选
需要导入的文件下载地址(有参数file,可以不用传)
示例值:
https://domain.com/files/download/test.docx
fileName
string 
可选
需要导入的文件名称(有参数file,可以不用传)
示例值:
test.docx

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://office.shimoapi.com/sdk/v2/api/files/v1/import' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NDAwMTk1MDF9.wBfjvKigaNDeRldcKlJLr6FFHRGw50q7RYfuYb7Jy5U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NDAwMTk1MDF9.Ta124wvF-lbpge6Ytah-7LyasBfu0SnZgDyu3GuwXDM' \
--form 'fileId="file-import-6"' \
--form 'type="document"' \
--form 'file=@"/Users/luyang/Documents/TempDoc/shimo_test.docx"'

返回响应

🟢200成功
application/json
Body
status
integer 
必需
导入状态,非 0 表示异常
message
string 
必需
导入异常时的提示信息
data
object 
必需
taskId
string 
必需
导入任务的标识 ID,调用导入进度接口时,请带上该参数。导入失败时请提供此 ID 用于调试
示例
{
  "status": 0,
  "message": "string",
  "data": {
    "taskId": "string"
  }
}
上一页
创建预览文档
下一页
获取导入进度
Built with