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/oauth/token
生成访问令牌以访问 Connect API。
此端点实现 OAuth 2.0token端点,作为使用代码交换证明密钥 (PKCE) 的授权码流程的一部分。有关更多信息,请参阅身份验证。
要生成访问令牌,您必须提供以下信息之一:
授权码
刷新令牌
使用授权码或刷新令牌生成令牌可让您的集成代表用户行事。您必须首先获得用户授权并获取授权码。
访问令牌的最大大小为 4 KB,并且仅在指定时间段内有效。有效期(当前为 4 小时)显示在端点响应中,并且可能会发生变化。
端点身份验证
对此端点的请求需要使用您的客户端 ID 和客户端密钥进行身份验证,使用以下方法之一*:*
基本访问认证(推荐):对于基本访问认证,{credentials}字符串必须是的Base64编码值{client id}:{client secret}。
主体参数client_id:使用和client_secret主体参数提供您的集成凭据。
使用授权码生成访问令牌
要使用授权码生成访问令牌,您必须:
设置。grant_type``authorization_code
提供code_verifier您在创建用户授权 URL 时生成的值。
提供用户授权集成后您收到的授权码。
使用刷新令牌生成访问令牌
使用refresh_token来自上一个用户令牌请求的值,您可以获得一个新的访问令牌,其范围与上一个相同或更小,但有效期已更新。您还将收到一个新的刷新令牌,您可以使用它再次刷新访问令牌。
要刷新现有访问令牌,您必须:
设置。grant_type``refresh_token
提供refresh_token先前的令牌请求。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/rest/v1/oauth/token' \
--header 'Authorization: Basic {credentials}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'code_verifier=i541qdcfkb4htnork0w92lnu43en99ls5a48ittv6udqgiflqon8vusojojakbq4' \
--data-urlencode 'code=kp8nnroja7qnx00.opyc1p76rcbyflsxbycjqfp3ub8vzsvltpzwafy9q5l45dn5fxzhe7i7a6mg1i2t8jpsa6sebdeumkzzhicskabgevrxsssec4dvjwfvhq4gs3ugghguar0voiqpfb7axsapiojoter8v3w2s5s3st84jpv2l06h667iw241xngy9c8=vu1tnjp7sz' \
--data-urlencode 'redirect_uri=https://example.com/process-auth'
响应示例响应示例
{
  "access_token": "JagALLazU0i2ld9WW4zTO4kaG0lkvP8Y5sSO206ZwxNF4E1y3xKJKF7TzN17BXTfaNOeY0P88AeRCE6cRF7SJzvf3Sx97rA80sGHtFplFo",
  "refresh_token": "JABix5nolsk9k8n2r0f8nq1gw4zjo40ht6sb4i573wgdzmkwdmiy6muh897hp0bxyab276wtgqkvtob2mg9aidt5d6rcltcbcgs101",
  "token_type": "Bearer",
  "expires_in": 14400,
  "scope": "asset:read design:meta:read design:permission:read folder:read"
}

请求参数

Header 参数
Authorization
string 
可选
示例值:
Basic {credentials}
Content-Type
string 
必需
示例值:
application/x-www-form-urlencoded
Body 参数application/x-www-form-urlencoded
grant_type
string 
可选
authorization_code:用于将授权码交换为访问令牌。
refresh_token:使用刷新令牌生成访问令牌。
示例值:
authorization_code
code_verifier
string 
可选
code_verifier您在创建用户授权 URL 时生成的值。
示例值:
i541qdcfkb4htnork0w92lnu43en99ls5a48ittv6udqgiflqon8vusojojakbq4
code
string 
可选
用户授权集成后您收到的授权码。
示例值:
kp8nnroja7qnx00.opyc1p76rcbyflsxbycjqfp3ub8vzsvltpzwafy9q5l45dn5fxzhe7i7a6mg1i2t8jpsa6sebdeumkzzhicskabgevrxsssec4dvjwfvhq4gs3ugghguar0voiqpfb7axsapiojoter8v3w2s5s3st84jpv2l06h667iw241xngy9c8=vu1tnjp7sz
redirect_uri
string 
可选
要交换的刷新令牌。您可以从生成访问令牌时收到的成功响应中复制此值。
示例值:
https://example.com/process-auth

返回响应

🟢200成功
application/json
Body
access_token
string 
必需
用于向 Canva Connect API 端点进行身份验证的持有者访问令牌。如果使用authorization_code或请求refresh_token,则允许您代表用户行事。
refresh_token
string 
必需
您可以用来刷新访问令牌的令牌。
token_type
string 
必需
返回的 token 类型。此类型始终为Bearer。
expires_in
integer 
必需
令牌的到期时间(以秒为单位)。
scope
string 
已授予令牌的范围。
可选
修改于 2024-06-26 08:48:41
上一页
概述
下一页
审视访问令牌
Built with