How to Get Your BigCommerce API Key
Your BigCommerce store allows you to generate API keys that can be used to manage your storefront programmatically. Whether you're building a custom BigCommerce app, or your BigCommerce design agency has requested your API key, this we've got you covered in this article. Let's get your key!
Follow the steps below to get your API key
- Log into your BigCommerce Dashboard
- In the sidebar on the left, click Settings
- On the Settings page, scroll to the very bottom and click Store-level API accounts
- On the Store-level API accounts page, click Create API Account
- Ensure V2/V3 API Token is selected, and name your key "Ventura", or anything you like
- To assign full permissions to the API key, go down the list and click the rightmost button for each permission
- Click Save, and your full API key information will download as a text file to your computer
Congratulations! You have successfully retrieved your BigCommerce API
Token / BigCommerce API Key.
It is very important that you keep the API key in a safe place, as it
can control your entire ecommerce store.
This token is for both the BigCommerce API V2, and BigCommerce API V3 and can be used for a wide variety of BigCommerce API integrations. To send this to your BigCommerce Development Agency, copy the contents of the downloaded text file and send it to them via email or project management software.
Frequently Asked Questions
What is a BigCommerce API Key?
A BigCommerce API key allows you to manage your BigCommerce store programmatically. It is essential for building custom apps or integrating with other platforms.
How do I log into my BigCommerce Dashboard?
To start the process, click this link to log into your BigCommerce Dashboard using your store credentials.
Where do I find the option to generate an API key in the Dashboard?
Once you're logged in, click on 'Settings' in the sidebar on the left. Scroll to the bottom and click on 'Store-level API accounts'.
How do I create a new API account?
On the 'Store-level API accounts' page, click the 'Create API Account' button.
What should I name my API key?
You can name your API key anything you like, such as "Ventura".
How do I set permissions for my API key?
To assign full permissions, go down the list of permissions and click the rightmost button for each one.
How do I save my API key?
Click the 'Save' button, and your API key information will download as a text file to your computer.
What versions of the BigCommerce API does this key work for?
The generated API key is compatible with both BigCommerce API V2 and V3.
How do I share my API key with my BigCommerce Development Agency?
You can copy the contents of the downloaded text file and send it to your development agency via email or project management software.
What can I do with my BigCommerce API key?
Your API key can be used for a wide variety of integrations, including custom BigCommerce apps and third-party services.