How to Create an API Key on BigCommerce for Theme Development

How to Create an API Key on BigCommerce for Theme Development

If you’re working with a developer on your BigCommerce store, one of the first things you’ll need to do is generate an API key. This key allows your developer to securely access your store and build or customize it as needed. In the video below, I walk you through the process step-by-step to ensure your API key is created correctly using the owner credentials.

But why is this important? Without the correct API key setup, your developer won’t be able to access the store or make necessary changes. In this guide, I’ll explain how to create a BigCommerce API key and give your developer the access they need, without any technical headaches.

Watch the video for the full walkthrough, and see the summarized steps below to help you get started quickly.

Key Steps to Generate a BigCommerce API Key

  1. Log in with Owner Credentials (00:00)
    • To create the API key, make sure you are logged in with the owner credentials. You’ll know you’re logged in correctly if you see the support pin in the bottom left corner of the dashboard.
  2. Verify Owner Account (00:25)
    • If you don’t see the support pin, you’re logged in with the wrong account. Head to Account Settings > Users to find out which account is the owner, and log in using those credentials.
  3. Access API Accounts (00:58)
    • Once logged in as the owner, navigate to Advanced Settings > API Accounts. BigCommerce now offers two types of API accounts, but for your developer, select Stencil CLI Token.
  4. Enable Publish Theme Rights (01:29)
    • Be sure to check the Publish Theme box so your developer can push changes from local development to your live store.
  5. Save and Share the API Key (02:00)
    • After clicking save, a text file with the API credentials will be automatically downloaded. You can send this file to your developer, or manually copy and paste the API key into a document.

Why Watching the Video Matters

Setting up the API key correctly is critical to ensuring your developer can do their job smoothly. The video provides a full walkthrough, covering common mistakes like not using the owner credentials and how to make sure your developer has the right access levels. Watching the video will help you avoid these pitfalls and make the process easier.

Ready to get started? Watch the video above and follow the steps to give your developer the access they need to build or enhance your BigCommerce store.

Full Transcript

(00:00)
Hello, in this video, I’m going to show you how to generate an API key for the developer that’s helping you with your BigCommerce store.
To do this, you’ll need to log into the backend of your BigCommerce store using the owner credentials. If you try to log in with anything other than the owner credentials, BigCommerce won’t let you create the API key.
You’ll know you’re logged in with the owner credentials if you look down in the bottom left and see a support pin. The support pin only shows for the owner account. If you don’t see it, you’re logged in with the wrong account.
If that’s the case, click into Account Settings > Users, and it will show you which account is the owner. You’ll then need to log in with the correct credentials.

(00:25)
Once you’re logged in with the owner account, to create the API key, go to Advanced Settings and then API Accounts.
BigCommerce made a change recently where, when you create an API account, there are two types of accounts you can create. For your developer, they’re going to need the one that says Stencil CLI Token.
Click on that, and name the token something that will help you remember it. For example, you could name it “Kal’s Key” so that, later on, if Kal isn’t working on your store anymore, you’ll know to delete it.

(00:58)
The only other thing you need to do is check the box that says Publish Theme. The reason for this is that your developer will likely use local development to make changes to your store on their local machine. To push those changes to your live store, they’ll need publish rights.

(01:29)
After selecting Publish Theme, click Save. You’ll notice that a small text file will be automatically downloaded to your computer. This file contains the API key. You can send this file to your developer (or to me if you’re working with me).
Alternatively, you can also manually copy the API key from the screen and paste it into a document, but the text file is usually the easiest method.

(02:30)
And that’s it! This text file has everything your developer needs to work on your store. Thanks for watching!