Step-by-Step Guide: Verifying Pandectes Integration with Shopify’s Customer Privacy API
In this guide, you will learn how to check and verify the integration between the Pandectes GDPR Compliance app and Shopify’s Customer Privacy API through a detailed step-by-step process. Before proceeding with the verification steps, we assume that you have already installed our app and completed the necessary configuration, which we outline in the preliminary steps below.
Shopify Customer Privacy Settings
Before starting the check we suppose that you have configured the Shopify Customer Privacy Settings based on your needs. Check here to see how to properly configure your Shopify Customer Privacy Settings. This will ensure your Shopify store complies with regional privacy requirements by setting up regions and managing the Shopify cookie banner.
Pandectes Geolocation Settings
After selecting the desired regions from Shopify Customer Privacy Settings you will need to have the same regions selected on our side. For example for GDPR you will need to have selected a banner in Strict Mode. You can choose a strict banner type in our app’s Settings > Banner > Behavior tab (select one of the strict banner types) and for Geolocation, the banner should be displayed on EU with the first option enabled in Settings > Geolocation of our app.
Open Your Shopify Store in Incognito Mode
To begin, open your Shopify store in Incognito Mode. This will prevent any cached cookies or stored preferences from interfering with the verification process.
Open Developer Tools
Press F12 (Windows) or Cmd + Option + I (Mac) to open the Developer Tools in your browser. Navigate to the Console tab to monitor the consent and privacy settings. You can do the same by using right click on the page and selecting the inspect option.
Check Initial Privacy Settings Before Interacting with the Cookie Banner
Before interacting with the cookie consent banner, you can run the following commands in the console to check Shopify’s current privacy settings:
These commands will return true or false depending on whether the various types of data processing are allowed, according to the default privacy settings. For example, if you have configured your store to target EU regions in the Shopify admin and selected a strict banner configuration in our app, the first three commands will likely return false, while the fourth command (saleOfDataAllowed) will return true.
Interact with the Cookie Consent Banner
Now, interact with the cookie consent banner on your store (e.g., by accepting or rejecting cookies). This step simulates a visitor’s consent choice.
Monitor Consent Events
To verify that Shopify is receiving consent information from our app, use the following command to listen for consent events:
This will print the consent data to the console when the user makes a choice (accept or reject cookies). You should see output indicating that the event has been captured.
Recheck Privacy Settings After Interaction
Once you’ve accepted or rejected the cookie consent, run the following commands again to see if Shopify’s privacy settings have updated correctly based on the user’s choice:
Compare these results with your initial checks to confirm that Shopify has updated the settings based on the consent choice. For instance, if you have configured your store to target EU regions in the Shopify admin and selected a strict banner configuration in our app, and clicked accept then all four commands will now likely return true.
Confirm the Integration
If the commands return values that reflect the user’s consent choice and you see the visitorConsentCollected event in the console, this confirms that our app is correctly passing consent information to Shopify’s Customer Privacy API.
Our app ensures that visitor consent is communicated to Shopify. From there, Shopify takes responsibility for managing cookies and handling analytics according to the consent provided by the user. If these steps confirm that the integration is working as expected, Shopify is correctly handling your store’s cookie and analytics processes.
If any of these steps don’t resolve the issue or you need further assistance, please don’t hesitate to contact us through the app chat support. We’re here to help ensure your store remains compliant and your users’ consent choices are accurately reflected.
Preliminary steps
Shopify Customer Privacy Settings
Before starting the check we suppose that you have configured the Shopify Customer Privacy Settings based on your needs. Check here to see how to properly configure your Shopify Customer Privacy Settings. This will ensure your Shopify store complies with regional privacy requirements by setting up regions and managing the Shopify cookie banner.
Pandectes Geolocation Settings
After selecting the desired regions from Shopify Customer Privacy Settings you will need to have the same regions selected on our side. For example for GDPR you will need to have selected a banner in Strict Mode. You can choose a strict banner type in our app’s Settings > Banner > Behavior tab (select one of the strict banner types) and for Geolocation, the banner should be displayed on EU with the first option enabled in Settings > Geolocation of our app.
Guide to check integration with Shopify’s Customer Privacy API
Open Your Shopify Store in Incognito Mode
To begin, open your Shopify store in Incognito Mode. This will prevent any cached cookies or stored preferences from interfering with the verification process.
Open Developer Tools
Press F12 (Windows) or Cmd + Option + I (Mac) to open the Developer Tools in your browser. Navigate to the Console tab to monitor the consent and privacy settings. You can do the same by using right click on the page and selecting the inspect option.
Check Initial Privacy Settings Before Interacting with the Cookie Banner
Before interacting with the cookie consent banner, you can run the following commands in the console to check Shopify’s current privacy settings:
window.Shopify.customerPrivacy.preferencesProcessingAllowed();
window.Shopify.customerPrivacy.analyticsProcessingAllowed();
window.Shopify.customerPrivacy.marketingAllowed();
window.Shopify.customerPrivacy.saleOfDataAllowed();These commands will return true or false depending on whether the various types of data processing are allowed, according to the default privacy settings. For example, if you have configured your store to target EU regions in the Shopify admin and selected a strict banner configuration in our app, the first three commands will likely return false, while the fourth command (saleOfDataAllowed) will return true.
Interact with the Cookie Consent Banner
Now, interact with the cookie consent banner on your store (e.g., by accepting or rejecting cookies). This step simulates a visitor’s consent choice.
Monitor Consent Events
To verify that Shopify is receiving consent information from our app, use the following command to listen for consent events:
document.addEventListener("visitorConsentCollected", (event) => console.log(event.detail));This will print the consent data to the console when the user makes a choice (accept or reject cookies). You should see output indicating that the event has been captured.
Recheck Privacy Settings After Interaction
Once you’ve accepted or rejected the cookie consent, run the following commands again to see if Shopify’s privacy settings have updated correctly based on the user’s choice:
window.Shopify.customerPrivacy.preferencesProcessingAllowed();
window.Shopify.customerPrivacy.analyticsProcessingAllowed();
window.Shopify.customerPrivacy.marketingAllowed();
window.Shopify.customerPrivacy.saleOfDataAllowed();Compare these results with your initial checks to confirm that Shopify has updated the settings based on the consent choice. For instance, if you have configured your store to target EU regions in the Shopify admin and selected a strict banner configuration in our app, and clicked accept then all four commands will now likely return true.
Confirm the Integration
If the commands return values that reflect the user’s consent choice and you see the visitorConsentCollected event in the console, this confirms that our app is correctly passing consent information to Shopify’s Customer Privacy API.
Final Notes
Our app ensures that visitor consent is communicated to Shopify. From there, Shopify takes responsibility for managing cookies and handling analytics according to the consent provided by the user. If these steps confirm that the integration is working as expected, Shopify is correctly handling your store’s cookie and analytics processes.
If any of these steps don’t resolve the issue or you need further assistance, please don’t hesitate to contact us through the app chat support. We’re here to help ensure your store remains compliant and your users’ consent choices are accurately reflected.
Updated on: 18/10/2024
Thank you!