Obtaining BigCommerce Credentials
Credentials are the conduit for communications between Business Central and BigCommerce
As part of the setup process, it is necessary to obtain credentials from your BigCommerce site that will grant CSM access to send and retrieve data. The credentials you need to obtain depends on the ways in which you want to integrate CSM with BigCommerce:
- You must create an API account on your BigCommerce platform and obtain credentials from it to use basic functionality.
- If you have installed the B2B Edition plugin on your BigCommerce platform and want to integrate it with Business Central, you must create API version 2 and version 3 API accounts and obtain credentials from them.
Obtaining BigCommerce API Credentials
You must create an API token that will allow CSM to send and receive necessary information between your BigCommerce store and Business Central.
- Log in to your BigCommerce admin portal. You must be logged in under the account that has been assigned as your BigCommerce store owner.
- Choose the Settings menu item located on the lefthand side of the page
- On the Settings page, locate the API section and choose Store-level API accounts
- On the Store-level API accounts page, choose the Create API account button
- On the Create account page, fill in the fields as follows:
- Token type: choose the V2/V3 API token option to indicate that you want to create a token using BigCommerce’s admin APIs.
-
- Name: enter a name for the API token
- OAuth scope: indicate which BigCommerce API resources can be accessed via the token. Enabling these resources will allow CSM to access and update different types of information on your BigCommerce store. Setting all resources to the create or modify option will ensure that CSM can send and retrieve all necessary data types.
- When you are done configuring these settings, choose the Save button
BigCommerce will present a screen containing the API credentials for the newly defined API account. In addition, depending on which web browser you are using, a text file containing this information may be automatically downloaded to your computer. These API credentials include a client ID, client secret, and access token; for the purposes of CSM, you will be entering the access token in Business Central. The other credentials are not used by CSM, but you should still ensure that you have them saved to a safe, accessible location.
- After ensuring that you have access to the API token’s credentials, choose the Done button to close the page.
Note: you will not be able to access a BigCommerce API token’s credentials after this initial display. If you have a need to enter this information and have not saved it to an accessible location, you will have to create a new API token and use its credentials instead.
B2B Credentialing
If you are working with BigCommerce’s B2B edition, you must create additional API tokens that will allow CSM to send and receive related B2B information between your BigCommerce store and Business Central. If you are not working with BigCommerce’s B2B tools, you may skip this requirement this step.
CSM uses both BigCommerce’s version 2 and version 3 APIs for B2B integration, so you must create a separate API token for each one.
- Log in to your BigCommerce admin portal. You must be logged in under the account that has been assigned as your BigCommerce store owner.
- Choose the Apps menu item located on the lefthand side of the page
- Under the Apps menu item, locate and choose the B2B Edition app
- On the B2B Edition page, choose the Settings menu item located on the lefthand side of the page, then choose API Accounts.
- On the API accounts page, choose the Create API account button
- On the Create account page, fill in the fields as follows:
- Token type: choose the V3 API token option to indicate that you want to create a token using BigCommerce’s version 3 APIs.
-
- Name: enter a name for the API token
- When you are done configuring these settings, choose the Save button
BigCommerce will present a screen containing the API token for the newly defined API account. In addition, depending on which web browser you are using, a text file containing this information may be automatically downloaded to your computer.
- After ensuring that you have access to the API token’s credentials, choose the Done button to close the page
Note: you will not be able to access a BigCommerce API token’s credentials after this initial display. If you have a need to enter this information and have not saved it to an accessible location, you will have to create a new API token and use its credentials, instead.
- Create an API token for BigCommerce’s version 2 APIs by repeating steps 5-8 above but choosing the V2 API token option as the token type.