Install through API - Shopify

Step by Step Installation

Follow this step by step guide to Install the Doofinder Shopify 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 > select "Create Store".


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

4. Click on “Continue”. On the following panel, you’ll need to complete the Settings URL, the Access Token, and the API secret key.

5. In a new window open the Shopify admin to find this information. Go to Shopify > Settings > Apps and Sales Channels > “Develop Apps”.

If you haven’t developed apps before you will need to accept and click on “Allow custom app development” button, just as you observe below:


6. Click on “Create an app”. On the pop-up screen write “Doofinder” on the app name block. After the app is created click on “Configure Admin API Scopes”.

7. In the Admin API access scopes select the following scopes (look for them in the “filter access scopes” search bar):
   • read_content
   • read_locales
   • read_products
   • read_translations
   • read_inventory
   • read_markets
   • read_publications
   • read_themes
   • write_themes

Make sure you have selected the elements from the list above and click on “save”.


8. Go to the API credentials section. Copy the URL appearing on the search bar and paste it into the Settings URL box in the store creation in the Doofinder Admin Panel.
9. Now, click on “Install app”. Your access token will be created. Reveal the token, copy and paste it in the Access token box in Doofinder.

Your Access token can only be revealed once. Make sure to reveal, copy and paste it in the store you are creating in Doofinder. If not, you will need to create the app and the store again.


10. At the bottom of the same panel, you will find the API Key and secret key section. Reveal the API secret key, copy and paste it in the corresponding box in store you are creating in Doofinder.
11. With all the completed fields, click on “Continue”, your data will start indexing and your store will be created.

If you want to track your conversion rate and other stats, there is a last step for you in the store creation process. Read the Create a New Webpixel section

Create a New WebPixel

If you want your conversion stats tracking and running in Doofinder, you will find an optional last step.

1. Copy the code appearing in the “Create Store” pop-up. Access your Shopify Admin > Settings > Customer Events.
2. Click on “Add custom pixel”.
3. Create a custom name and paste the code.
4. Click on “save” and “connect”, so you are all set to monitor your conversion.

Activate the Script

The script is generated automatically during the installation process, but it needs to be activated manually on your Doofinder Admin Panel.

To activate the Doofinder Script, follow these steps:

1. On your Admin Panel go to Configuration > Store Settings.
2. Scroll down to Platform Configuration > Doofinder Script, and enable the script by clicking on the switch.

Once this step is completed and the Doofinder Script shows as "activated", Doofinder should be functioning correctly on your online shop.

Account and Store Settings Panel

On the following sections, we will explore the fundamentals of the Admin Panel for a smooth start.

Account Panel

The Account section provides an overview of your plan, usage, billing, and invoices. Each section helps you manage a specific part of your Doofinder integration.

• My Subscription: View your current plan’s details, features, and limits, or explore upgrades.
• Usage: Monitor your app usage to manage resources effectively.
• Billing Information: Manage your payment methods and information.
• Invoices: Review payment history and invoices.
• Profile: Look at your profile information.
• API Keys: Create API Keys for enhanced management API requests.

• Team Members: Ensure your team has the required access to Doofinder Admin Panel. The access to certain parts of the Admin Panel is role-based to ensure that each user is only taken to sections they have permission to access. For example:

  • Owners and Administrators: Can view search analytics, so they are both sent to the "Search stats" page.
  • Managers: Handle search engine configurations, so they have access to the pages needed to manage search engines.
  • Billing: Responsible for account and subscription management, which is why they are taken to the "Account - My subscription" page.

  This system helps maintain security and streamline access by limiting each role to only the relevant parts of the Admin panel. If a user with insufficient permissions attempts to access a restricted section of the Admin Panel, they will be redirected to an error page.

  This page will inform them that they do not have the necessary access rights and prompt them to review their account permissions.

  

Store Settings Panel

In this panel you can manage your store information, these are the different sections you will find to set up or modify:

• Store Information: Keep your store’s name and industry classification updated.

• Platform Configuration: Find the following settings to manage your app:

  • Doofinder Script: Activate or deactivate the Doofinder Script from this option.
  • Update On Save: Keep your store’s product data synchronized in real time, ensuring updates are reflected instantly in your search results.
  • Metafields: Improve search relevance by indexing product metafields. This allows for more precise and tailored search results. Once the indexation of metafields has been enabled, you have to reindex the products in Doofinder.

  • Image Settings: Select the size of the images to display on the layer.

    Once the size has been changed, you have to reindex the products in Doofinder.

  • Languages: To associate a new language and/or currency to your Search Engine in your Store. Under this section you can also find Google Analytics Account/ Measurement ID, Measurement Protocol API Secret, and Doofinder’s Installation Script. Learn about each detail in Store Settings.

  • Sales Data configuration: Track sales effortlessly by configuring your checkout summary pages and your payment confirmation page. Learn how to configure your sales data here.

Doofinder Products

To access all the Search, Recommendations and Quiz Maker functionalities available, just go to your Admin Panel and click on the product you're subscribed to in the left-side menu. Inspect all functionalities and learn about our products in our Support Documentation page.