Canva

获取设计自动填充工作

开发环境

GET

/rest/v1/autofills/{jobId}

获取自动填充作业的状态和结果，包括自动填充的设计。

此 API 目前以预览版形式提供。请注意以下事项：

可能会有未公布的重大变化。

对预览 API 的任何重大更改都不会产生新的API 版本。

使用预览 API 的公共集成将不会通过审核流程，并且无法向所有 Canva 用户提供。

要使用此 API，您的集成必须代表Canva Enterprise组织成员用户行事。

获取使用创建设计自动填充作业 API 创建的设计自动填充作业的结果。

您可能需要向此端点发出多个请求，直到获得success或 failed状态。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/rest/v1/autofills/' \
--header 'Authorization: Bearer {token}'

响应示例

{
  "job": {
    "id": "450a76e7-f96f-43ae-9c37-0e1ce492ac72",
    "status": "success",
    "result": {
      "type": "create_design",
      "design": {
        "id": "DAFVztcvd9z",
        "title": "My summer holiday",
        "url": "https://www.canva.com/design/DAFVztcvd9z/edit",
        "thumbnail": {
          "width": 595,
          "height": 335,
          "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
        }
      }
    },
    "error": {
      "code": "autofill_error",
      "message": "string"
    }
  }
}

请求参数

Path 参数

jobId

string

必需

设计自动填充作业 ID。

Header 参数

Authorization

string

必需

示例值:

Bearer {token}

返回响应

🟢200成功

application/json

Body

job

object

必需

string

必需

使用提供的数据创建设计的异步作业的 ID。

status

string

必需

设计自动填充作业的状态。可以是以下之一： in_progress success failed

result

object

可选

设计自动填充作业的结果。仅当作业状态为时才显示success。

error

object

可选

如果自动填充作业失败，此对象会提供有关错误的详细信息。

修改于 2024-06-26 09:11:13

创建设计自动填充作业

概述