Store API Accounts

Most apps available in the App Marketplace are Single-Click Apps. They’re quick and easy to install, and don’t require the added steps of creating a dedicated API account, then supplying those credentials to a third party.

Some apps and integrations require special permission to communicate with or make changes to your store. These permissions are provided in the form of API accounts (also referred to as OAuth tokens or keys) and can be created directly from your control panel.

Only the store owner can create API accounts, and a maximum of 50 accounts can be created per store. To access Store API Accounts, go to Advanced SettingsAPI Accounts.

 

Make your apps future-proof by using OAuth. We strongly recommend building all BigCommerce apps with OAuth. OAuth is compatible with all current and planned BigCommerce APIs, including v2 Webhooks and our v3 API. Also, any apps intended for sale on the BigCommerce App Marketplace must use OAuth. BigCommerce is gradually deprecating its legacy support for Basic Authentication. If you still need a legacy API token/key, see Legacy API Accounts.

Creating an API Account

1. Click Create API Account.

Create API Account button highlighted

2. Enter a Name for the app/integration corresponding to this account and copy or make note of the API Path — you'll need it to interact with the API.

Name and API Path fields under Create API Account

3. Under OAuth Scopes, specify the API resources and permissions to which your app/integration requires access.

Individualy store resources can be set to none, read-only, or modify.

4. When you’re done making changes, click Save.

A successful save will display the pop-up shown below, containing the API credentials that your app will need for OAuth access – your Client ID, Client Secret, and Access Token. Also, a .txt file containing the same credentials will (on most browsers) download to your computer.

Pop-up displaying your Client ID, Client Secret, and Access Token

A .txt file with your API credentials will download to your computer

 

Keep your credentials! There is no way to re-display this pop-up after you select Done to dismiss it. Make sure you store your credentials – either by copying/pasting the contents of each field out of the pop-up, or by keeping the downloaded .txt file. We suggest adding the API Path value that you copied earlier (see Step 2).

 

Deleting an API Account

To delete a Store API account, under Actions, click the trashcan icon next to the Account Name.

Delete API account button highlighted

You can delete multiple accounts at once by checking the box to the left of each account, then clicking the trashcan icon in the top right of the list.

Account name check boxes and bulk delete button highlighted

Go to Store API Accounts in my store

Additional Resources

Was this article helpful?