Skip to main content

Authorization

Follow this guide to create a new BigCommerce Graph API credential that will allow Nexla to authenticate to and exchange data with your BigCommerce store.
bcgraph_api_auth.png

BigCommerce Graph API

Prerequisites​

Before creating a BigCommerce Graph API credential in Nexla, you need to create a Store API Credential in your BigCommerce store and obtain your store hash and API key. BigCommerce Graph API uses token-based authentication, where a storefront API token is generated using your Store API credentials.

BigCommerce Store API Credentials Setup​

BigCommerce Graph API requires Store API credentials to generate storefront API tokens. These credentials are used to authenticate requests to create tokens, which are then used to access the GraphQL Storefront API.

  1. Access BigCommerce Control Panel: Sign in to your BigCommerce Control Panel.

  2. Navigate to API Settings: Go to Advanced Settings → API Accounts (or Settings → API Accounts depending on your BigCommerce version).

  3. Create Store API Credential: Click Create API Account or Create V2/V3 API Token to create a new Store API credential. This will generate:

    • API Key: A unique identifier for your API credential
    • Store Hash: A unique identifier for your store (found in the API URL or credential details)

  4. Configure API Scopes: Ensure your Store API credential has the necessary scopes to create storefront API tokens. The credential needs permissions to create tokens for the GraphQL Storefront API.

  5. Identify Channel ID: Determine the channel ID you want to use for the storefront API token. Use 1 for the default store channel, or use a specific channel ID if you have multiple channels configured.

  6. Copy Credentials: Copy your API Key and Store Hash immediately after creation. Keep these credentials secure, as they provide access to your BigCommerce store data.

    BigCommerce Store API credentials provide programmatic access to your BigCommerce store. Keep your API Key and Store Hash secure and do not share them publicly or commit them to version control systems. The credentials are used to generate storefront API tokens, which are then used to authenticate GraphQL queries. For detailed information about creating Store API credentials, see the BigCommerce API documentation.

For additional information about BigCommerce GraphQL Storefront API authentication and credential management, see the BigCommerce GraphQL Storefront API documentation.

Create a BigCommerce Graph API Credential​

  • To create a new BigCommerce Graph API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – BigCommerce Graph API

BCGraphCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

BigCommerce Graph API Configuration​

  1. Enter your BigCommerce store hash in the Store Hash field. This should be the store hash generated by BigCommerce when you created your Store API Credential. The store hash is a unique identifier for your store and is used to construct the GraphQL API endpoint URL. You can find your store hash in the API credential details or in the API URL format https://api.bigcommerce.com/stores/{store_hash}/....

  2. Enter your BigCommerce API key in the API Key field. This should be the API key generated by BigCommerce when you created your Store API Credential. The API key is used to authenticate requests to create storefront API tokens, which are then used to access the GraphQL Storefront API.

    The Store Hash and API Key are used to generate storefront API tokens for accessing the BigCommerce GraphQL Storefront API. The API key is sent in the x-auth-token header when creating tokens, and the generated token is then used as a Bearer token (Authorization: Bearer {token}) for GraphQL queries. Keep your API key secure and do not share it publicly or commit it to version control systems. For detailed information about BigCommerce API authentication, see the BigCommerce API documentation.

  3. Enter the channel ID in the Channel ID field. This should be the channel ID for which you want to create the storefront API token. Use 1 for the default store channel, or enter a specific channel ID if you have multiple channels configured. The channel ID determines which channel's data will be accessible through the GraphQL API.

    The Channel ID determines which BigCommerce channel the storefront API token will have access to. Use 1 for the default store channel. If you have multiple channels (e.g., different storefronts or marketplaces), specify the appropriate channel ID. The token will only provide access to data for the specified channel. For detailed information about channels and channel IDs, see the BigCommerce API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.