Skip to content

Latest commit

 

History

History
140 lines (87 loc) · 5.19 KB

README.md

File metadata and controls

140 lines (87 loc) · 5.19 KB
Raw

Canva Connect API Starter Kit

Welcome to the Connect API starter kit for Canva's developers platform. 🎉

This repo contains our openAPI specifications, as well as a demo ecommerce web application built with the Connect API. The complete documentation for the platform is at canva.dev/docs/connect.

Requirements

  • Node.js v20.14.0
  • npm v9 or v10

Note: To make sure you're running the correct version of Node.js, we recommend using a version manager, such as nvm. The .nvmrc file in the root directory of this repo will ensure the correct version is used once you run nvm install.

OpenAPI Spec

The Canva Connect API doesn't maintain nor publish client SDKs, however, we have made our OpenAPI spec publicly available, so you can use it with your favorite code generation library, such as openapi-generator to generate client SDKs in your language of choice!

To demonstrate this, we're using openapi-ts to generate TypeScript SDKs in client/ts which is used in our demo app.

Demos: E-commerce Shop

Prerequisites

Before you can run this demo, you'll need to do some setup beforehand.

  1. Open the Developer Portal, and click Create an integration.

  2. Under Configuration → Configure your integration.

  • Integration name: Add a name.
  • Client ID: Make a note of this value; you'll need it in a later step.
  • Generate secret: Click this and save the secret in a secure location, as you'll need it for a later step.
  1. Under Scopes → Set the scopes, check the following boxes:
  • asset: Read and Write.
  • brandtemplate:content: Read.
  • brandtemplate:meta: Read.
  • design:content: Read and Write.
  • design:meta: Read.
  • profile: Read.
  1. Under Authentication → Add Authentication, locate URL 1 and enter the following value:
http://127.0.0.1:3001/oauth/redirect
  1. Under Return navigation, toggle on the Enable return navigation switch and enter the following as the Return Url:
http://127.0.0.1:3001/return-nav

How to run

  1. Install dependencies
npm install
cd demos/ecommerce_shop
  1. Add your integration settings to the demos/ecommerce_shop/.env file.
  • DATABASE_ENCRYPTION_KEY: This will encrypt and decrypt the tokens stored in the JSON database. A key is automatically get generated for you after running npm install, and will already be set in .env. If not, run npm start generate:db-key from the demos/ecommerce_shop directory.
  • CANVA_CLIENT_ID: This is the Client ID from the prerequisites.
  • CANVA_CLIENT_SECRET: This is the client secret you generated in the prerequisites.
  1. Run the app
npm start

Warning

Accessing the app via localhost:3000 will throw CORS errors, you must access the app via the below URL.

  1. View your app: http://127.0.0.1:3000

Demos: Connect API Playground

Prerequisites

Before you can run this demo, you'll need to do some setup beforehand.

  1. Open the Developer Portal, and click Create an integration.

  2. Under Configuration → Configure your integration.

  • Integration name: Add a name.
  • Client ID: Make a note of this value; you'll need it in a later step.
  • Generate secret: Click this and save the secret in a secure location, as you'll need it for a later step.
  1. Under Scopes → Set the scopes, select any permissions for endpoints you'd like to experiment with, plus the following:
  • profile: Read.
  1. Under Authentication → Add Authentication, locate URL 1 and enter the following value:
http://127.0.0.1:3001/oauth/redirect

How to run

  1. Install dependencies
npm install
cd demos/playground
  1. Add your integration settings to the demos/playground/.env file.
  • DATABASE_ENCRYPTION_KEY: This will encrypt and decrypt the tokens stored in the JSON database. A key is automatically get generated for you after running npm install, and will aready be set in .env.
  • CANVA_CLIENT_ID: This is the Client ID from the prerequisites.
  • CANVA_CLIENT_SECRET: This is the client secret you generated in the prerequisites.
  1. Run the app
npm start

Warning

Accessing the app via localhost:3000 will throw CORS errors, you must access the app via the below URL.

  1. View your app: http://127.0.0.1:3000

Decision Registry

Multer

We use Multer in our Express.js app to handle file uploads. It simplifies the process of uploading files and reduces the amount of code required. There are other alternatives to Multer, like express-fileupload that you can use in your own application.

Helpful Links

Canva Connect API - Getting Started Canva Connect API - Official Documentation