Canva
  1. 资产
Canva
  • 验证
    • 概述
    • 生成访问令牌
      POST
    • 审视访问令牌
      POST
    • 撤销令牌
      POST
  • 资产
    • 概述
    • 创建资产上传作业
      POST
    • 获取资产上传作业
      GET
    • 获取资产
      GET
    • 更新资产
      PATCH
    • 删除资产
      DELETE
  • 自动填充
    • 概述
    • 创建设计自动填充作业
      POST
    • 获取设计自动填充工作
      GET
  • 品牌模板
    • 概述
    • 获取品牌模版
      GET
    • 获取品牌模板数据集
      GET
    • 列出品牌模板
      GET
  • 评论
    • 概述
    • 创建评论
      POST
    • 获取评论
      GET
    • 创建回复
      POST
  • 设计
    • 概述
    • 创建设计
      POST
    • 列表设计
      GET
    • 获取设计
      GET
  • 设计导入
    • 概述
    • 创建设计导入作业
    • 获得设计导入工作
  • 导出
    • 概述
    • 创建设计导出作业
    • 获得设计出口工作
  • 文件夹
    • 概述
    • 创建文件夹
    • 获取文件夹
    • 更新文件夹
    • 删除文件夹
    • 列出文件夹项目
    • 移动文件夹项目
  • 用户
    • 概述
    • 获取当前用户的详细信息
    • 获取当前用户的个人资料
  • webhook
    • 获取 webhook 的公钥
  1. 资产

创建资产上传作业

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/rest/v1/asset-uploads
创建一个异步作业来上传资产。
启动一项新作业,将资产上传到用户的内容库。
此端点的请求格式为application/octet-stream字节主体。使用标头附加有关上传的信息Asset-Upload-Metadata。
您可以使用获取资产上传作业 API检查状态并获取使用此 API 创建的资产上传作业的结果。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/rest/v1/asset-uploads' \
--header 'Authorization: Bearer {token}' \
--header 'Asset-Upload-Metadata: { "name_base64": "TXkgQXdlc29tZSBVcGxvYWQg8J+agA==" }' \
--header 'Content-Type: application/octet-stream' \
--data-raw '@/path/to/file'
响应示例响应示例
{
  "job": {
    "id": "Msd59349ff",
    "status": "success",
    "asset": {
      "id": "Msd59349ff",
      "name": "My Awesome Upload",
      "tags": [
        "image",
        "holiday",
        "best day ever"
      ],
      "created_at": 1377396000,
      "updated_at": 1692928800,
      "thumbnail": {
        "width": 595,
        "height": 335,
        "url": "https://document-export.canva.com/Vczz9/zF9vzVtdADc/2/thumbnail/0001.png?<query-string>"
      }
    }
  }
}

请求参数

Header 参数
Authorization
string 
必需
以令牌的形式提供凭证来验证请求Bearer。
示例值:
Bearer {token}
Content-Type
string 
必需
指示请求中发送的信息的媒体类型。必须设置为application/octet-stream。
示例值:
application/octet-stream
Asset-Upload-Metadata
string 
必需
正在上传的资产的元数据。
示例值:
{ "name_base64": "TXkgQXdlc29tZSBVcGxvYWQg8J+agA==" }
Body 参数text/plain
示例

返回响应

🟢200成功
application/json
Body
job
object 
必需
id
string 
必需
资产上传作业的ID。
status
string 
必需
资产上传作业的状态。 可以是以下之一: failed in_progress success
asset
object 
必需
资产对象,包含有关资产的元数据。
修改于 2024-06-26 09:07:43
上一页
概述
下一页
获取资产上传作业
Built with