导出文件

POST

/sdk/v2/api/files/v1/export/{fileId}

将在线编辑文件导出为 Office 文件、PDF 等格式，不同套件支持的导出格式有所不同。

导出文件过程是一个异步处理过程，接口请求成功仅代表导出服务收到并开始处理导出请求，实际是否成功需要轮询获取导出进度接口查询导出任务是否完成。当任务完成后，用「获取导出进度」返回的链接 ( data.downloadUrl 字段) 下载文件。

此接口允许同时将同一个石墨文件导出为不同的文件类型，例如：同时将轻文档导出为 PDF 和 Word 两个格式。任务执行的最长时间为 10 分钟。

导出支持的文件格式

石墨文件类型	默认导出的文件类型	支持导出的文件类型
document	docx	docx, md, jpg, pdf
documentPro	docx	docx, pdf, wps
spreadsheet	xlsx	xlsx
presentation	pptx	pptx, pdf

请求参数

Path 参数

fileId

string

必需

示例值:

1ab6ffd1930d627b

Header 参数

X-Shimo-Signature

string

必需

示例值:

X-Shimo-Token

string

必需

示例值:

Body 参数application/json

type

string

可选

需要导出的文件类型，不传时按照默认类型导出

示例

{
    "type": "xlsx"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://office.shimoapi.com/sdk/v2/api/files/v1/export/1ab6ffd1930d627b' \
--header 'X-Shimo-Signature: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJleHAiOjE3NDAwMTk1MDF9.wBfjvKigaNDeRldcKlJLr6FFHRGw50q7RYfuYb7Jy5U' \
--header 'X-Shimo-Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImZkZWEwODk5NTYwMzRkMzliOWZjYmZmOTg1M2NhYWZiIn0.eyJ1c2VySWQiOjQ5LCJtb2RlIjoic2hpbW8iLCJleHAiOjE3NDAwMTk1MDF9.Ta124wvF-lbpge6Ytah-7LyasBfu0SnZgDyu3GuwXDM' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "xlsx"
}'

返回响应

🟢200成功

application/json

Body

status

integer

必需

导出状态，非 0 表示异常

message

string

必需

导出异常时的提示信息

data

object

必需

taskId

string

必需

导出任务的标识 ID，调用导出进度接口时，请带上该参数。导出失败时请提供此 ID 用于调试

示例

{
    "status": 0,
    "message": "",
    "data": {
        "taskId": "3oo4vnBJgcG5HxMm:1:603:docx"
    }
}

获取导入进度

获取导出进度