创建设计导出作业

开发环境

POST

/rest/v1/exports

创建一个异步作业以从 Canva 导出设计。

启动新作业以从 Canva 导出文件。导出的文件生成后，您可以使用提供的链接下载它。

请求需要设计ID和导出的文件格式。

支持的格式：pdf( .pdf)、jpg( .jpg)、png( .png)、gif( .gif)、pptx( .pptx) 和 mp4( .mp4)。

您可以使用获取设计导出作业 API检查状态并获取使用此 API 创建的导出作业的结果。

如果您设置export_quality为，当设计包含高级元素，并且调用用户未购买这些元素或未使用具有高级功能的 Canva 计划（例如 Canva Pro）时，pro导出可能会失败。

目前，您无法使用导出 API 导出视频设计。此功能将在将来添加。有关每种 Canva 设计类型支持的导出格式的更多信息，请参阅概述页面。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/rest/v1/exports' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "design_id": "DAVZr1z5464",
  "format": {
    "type": "pdf",
    "size": "a4",
    "pages": [
      2,
      3,
      4
    ]
  }
}'

响应示例

{
  "job": {
    "id": 1332472403399775200,
    "status": "in_progress"
  }
}

请求参数

Header 参数

Authorization

string

必需

以令牌的形式提供凭证来验证请求Bearer。

示例值:

Bearer {token}

Content-Type

string

必需

指示请求中发送的信息的媒体类型。必须设置为application/json。

示例值:

application/json

Body 参数application/json

design_id

string

设计 ID。

必需

format

object

必需

有关所需导出格式的详细信息。

type

string

必需

可以是下列之一： pdf：将设计导出为 PDF。提供纸张尺寸是可选的。默认纸张尺寸为 A4。 jpg：将设计导出为 JPG。必须提供压缩质量。可以指定高度或宽度（或两者），否则文件将以其默认大小导出。 png：将设计导出为 PNG。可以指定高度或宽度（或两者），否则文件将以默认大小导出。您还可以指定是否无损导出文件，以及是否将多页设计导出为单个图像。 pptx：将设计导出为 PPTX。 gif：将设计导出为 GIF。可以指定高度或宽度（或两者），否则文件将以默认大小导出。大型设计将缩小，并且纵横比将始终保持。 mp4：将设计导出为 MP4。您必须指定导出视频的质量。

size

string

可选

pages

array[integer]

可选

示例

返回响应

🟢200成功

application/json

Body

job

object

必需

integer

导出作业 ID。

必需

status

string

必需

作业的导出状态。新创建的作业将为in_progress，并最终变为success或failed。

修改于 2024-06-26 09:59:26

概述

获得设计出口工作