Proteside Docs

Verify the installation

Confirm in the dashboard and in the browser console that the SDK is active on your checkout.

After publishing the snippet, open your store's checkout page in a browser. Within a few seconds the SDK starts reporting. Use the three checks below to confirm everything is working.

In the dashboard

Top indicator

At the top of the dashboard (on the desktop version) there's an SDK status indicator:

  • Proteside active (green): the store has recent real traffic from the SDK.
  • Proteside not detected (red): no recent real traffic.

The indicator links to Settings → Pages & Domains. There, the Detected pages section lists every page that has already sent events, grouped by domain, with the SDK active badge (recent activity) or Not detected.

SDK Health

The SDK Health page shows whether the SDK is reporting real customer traffic, separate from synthetic checks.

SDK Health page with the status bar, domains with real traffic, 48-hour metrics, the events-per-hour chart, SDK versions and the configuration
StatusMeaning
SDK activeReal customer sessions reported recently.
SDK not detectedNo events received yet.
Only synthetic checksOnly Proteside's synthetic checker has sent events. No real customer has gone through the checkout with the SDK yet.
SDK silentThere's history, but no recent customer sessions. Check that the snippet is still published.
SDK paused (developer mode)Developer mode is on and the SDK doesn't run any protections.

The page also shows Domains with real traffic, the totals for the last 48 hours, the Events per hour chart, the SDK versions seen in the last 7 days and the current configuration (channel, developer mode and protection mode). Data is aggregated by hour: reload the page to refresh it.

More details in SDK Health.

In the browser

Open the checkout, open the developer tools (F12) and go to the Console tab.

SDK status

Proteside.getStatus()

Expected response, a few seconds after the page loads:

{
  initialized: true,            // the SDK finished starting up
  version: '1.2.0',
  installationOrderValid: true  // false = there's a script before the snippet
}
ResultWhat it means
Proteside is not definedshield.js didn't load. Check that the snippet is published, that your CSP allows cdn.proteside.com and that an ad blocker didn't interfere.
initialized: false for more than a few secondsdata-key is missing, the key has an invalid format, or shield.js was loaded as type="module".
installationOrderValid: falseThere's a script before the snippet. See Troubleshooting.

If developer mode is on, SDK Health shows SDK paused (developer mode).

Complete snippet

Open the published page's source (Ctrl+U) and check that the block between <!-- Proteside Start --> and <!-- Proteside End --> is the first item in the <head> and has both tags: the bootstrapper's inline <script> and the shield.js tag.

Network requests

In the Network tab, filter by proteside:

RequestExpected response
shield.js from cdn.proteside.com200
Requests to app.proteside.comsuccess (2xx), a few seconds after the page loads

A 4xx error points to a key or account problem: check SDK Health. If you rotated the key, copy the current snippet from Pages & Domains.

What to expect in the first few minutes

  1. First few seconds: initialized: true in the console and the first requests to app.proteside.com.
  2. Within 30 seconds: reload the dashboard. The top indicator switches to Proteside active, and the page shows up in Detected pages.
  3. First few minutes: the page's scripts show up in Scripts with the Needs review status. Review them and authorize the legitimate ones; see Scripts.
  4. When a customer pays: the Payment Integrity cards move from WAITING to INTACT as each method is validated. See Payment integrity and Pix.

The SDK Health chart is aggregated by hour. A newly sent event may take a few minutes to show up there, even when the top indicator is already green.

Next steps

On this page