Install through API - BigCommerce

Follow this step by step guide to Install the Doofinder Bigcommerce through API.

• If you are a new user, check this article to create a new Doofinder account.

If you have an account already or just created one, follow these guidelines:

1. Log in to your Doofinder Admin Panel.
2. Click on "Create Store".

If you are new, a "Create store" button will appear on the front page. If you don't see it or prefer a different method, go to the top bar, click the "Store" dropdown menu, and select "Create Store".


3. Once clicked, a pop-up window will appear where you need to enter the URL of your website, and select what platform you are using. Usually, Doofinder identifies the BigCommerce platform automatically.

4. Click on “Continue”. On the following panel, you’ll need to complete the API Path and the Access Token fields.


This information can be found in your Bigcommerce backend > Settings > scroll down to the API panel > click on Store-level API Accounts.


5. Click on “Create API Account”.

To create an API account on BigCommerce, you must have the appropriate role and permissions. The "Owner" role is required for the installation process. Learn more on BigCommerce User Roles and Permissions.


6. Once in the Create Account panel, name this account as “Doofinder API Key”.

Make sure this is the unique account created under this name. Otherwise, an error could show when proceeding.


7. Then, search for the API Path link, and paste it on the API Path field on the “Create Store” on Doofinder's Admin Panel.


8. Now, on the OAuth Scopes Panel, select the following options just as shown on the images:

It is important to select the correct 10 options in the API Panel, as shown in the images. If you don't and something goes wrong after creation, you'll need to create a new API account on BigCommerce.



9. Save the changes. Now, you will be able to look for the Access Token on the BigCommerce API credentials panel. Copy and paste it back on your Doofinder “Create Store” panel.


10. Once completed, click on “Create”. The indexation process should start. You can now start using Doofinder on your Bigcommerce Store.

Doofinder Script

Once you complete the installation process in Doofinder, the script will be automatically added to your theme; no further action is required on your part.

Platform Configuration

To access your platform configuration navigate to your Doofinder's Admin Panel, go to Configuration > Store Settings > Platform Configuration. You will find the following functionalities:

• Doofinder Script: this option is activated by default. From here you can disable the script by switching it off.

• Update on save: this functionality allows you to keep your store's product data synchronized in real time. You can enable it or disable it from the Platform Configuration section.

• Metafields: this feature improves search relevance and allows more precised search results. Enable it when you have indexed product metafields.

API installation troubleshooting

As mentioned earlier, if the OAuth scopes are not selected correctly, the installation process will not function properly.

Make sure the following scopes are changed from "None" to their corresponding fields:

• Content: "modify"
• Checkout content: "modify"
• Customers: "modify"
• Customers login: "login"
• Information & settings: "read-only"
• Products: "read-only"
• Sites & routes: "read-only"
• Channel settings: "read-only"
• Storefront API tokens: "manage"
• Storefront API customer impersonation tokens: "manage"