How to create integration

• 1 minute to read

In this article, you will learn how to integrate Customer's Canvas into your BigCommerce store.

Prerequisites

To create an integration, you need the following:

• A store in BigCommerce with the owner role
• A Customer's Canvas tenant

Preparing credentials

In the BigCommerce admin panel, navigate to Settings > Store-level API Tokens. On a new page, click the Create API account button. Learn how to create an API account in the BigCommerce Help Center.

When a new page opens, fill in the following fields:

1. In the Token type drop-down box, select the V2/V3 API token.
2. In the Name input field, enter a name for the account.
3. The API path input field is filled in automatically.
4. In the OAuth scopes part, select the following scopes:
   • Content - modify
   • Checkout content - modify
   • Customers - None
   • Customers login - None
   • Information & settings - read-only
   • Marketing - None
   • Orders - modify
   • Order transactions - None
   • Create payments - None
   • Get payment methods - None
   • Stored Payment Instruments - None
   • Products - modify
   • Themes - modify
   • Carts - modify
   • Checkouts - None
   • Sites & routes - read-only
   • Channel settings - read-only
   • Channel listings - read-only
   • Storefront API tokens - None
   • Store logs - None
   • Store Locations - None
   • Store Inventory - None
   • Fulfillment Methods - None
   • Order Fulfillment - None
   • Metafield Ownership - None
   • Metafields Access - Standard

Finally, click Save. Now, you can see the BigCommerce API credentials, such as:

• Client ID
• Client secret
• Access token

Now, download the text file with this information in the TXT format.

Note

You won't be able to see and save this file again.

Creating integration in BackOffice

In BackOffice, go to Settings > Integrations. Then, click the Create new button.

In the following form, fill in the following text fields:

• Type - BigCommerce
• Name - arbitrary
• Allow at - a baseUrl of your storefront
• BigCommerce Access Token - the token from BigCommerce
• BigCommerce ApiPath - basic API link. This link may look like this: https://api.bigcommerce.com/stores/{store_hash}/v3/
• BigCommerce ClientId - ID from BigCommerce
• BigCommerce Client Name - client's name that you create
• BigCommerce Client Secret - secret from BigCommerce
• BigCommerce Integration Name - the name of your integration from BigCommerce.

Finally, click Save.

Now your integration is ready, and you can prepare and import a theme for BigCommerce.