ROI Hunter Easy Integrations

Iframe Initialization Payload

<script>
    window.addEventListener("DOMContentLoaded", function () {
        const payload = {
            profile: 'production', // or 'staging' for testing mode
            plugin_version: '1.0.0',
            client_token: 'abcdefgh123', // Token for Plugin API authentication
            api_base_url: 'https://mybeststore.com/api/roi-hunter-easy/v3/',
            access_token: 'cdefghi' // User authentication token issued by RH Easy, has empty value during the first start
        };

        const payloadBase64 = btoa(
            unescape(
                encodeURIComponent(
                    JSON.stringify(payload)
                )
            )
        );

        // For testing environment: const iframeUrl = `https://goostav-fe-staging.roihunter.com?platform=WOO_COMMERCE&payload=${payloadBase64}`;
        const iframeUrl = `https://goostav-fe.roihunter.com?platform=WOO_COMMERCE&payload=${payloadBase64}`;
        document.getElementById('rhEasyIframe').src = iframeUrl;
    }, false);

    function onRhEasyIframeLoad() {
        // Create IE + others compatible event handler
        var eventMethod = window.addEventListener ? "addEventListener" : "attachEvent";
        var eventer = window[eventMethod];
        var messageEvent = eventMethod === "attachEvent" ? "onmessage" : "message";

        // Listen to message from child window
        eventer(messageEvent, function (e) {
            if (e.data.type === "roihunter_plugin_height") {
                // Change size of iFrame to correspond new height of content
                document.getElementById('rhEasyIframe').style.height = e.data.height + 'px';
            } else if (e.data.type === "roihunter_location") {
                window.top.location = e.data.location;
            }
        }, false);
    }
</script>
<iframe id="rhEasyIframe" scrolling="yes" frameBorder="0" allowfullscreen="true" align="center" onload="onRhEasyIframeLoad()"
        style="width: 100%; min-height: 500px">
    <p>Your browser does not support iFrames.</p>
</iframe>

Plugin API

• Order API
• Product API
• State API
• Store Info API

Js SDK

<script src="https://storage.googleapis.com/goostav-static-files-master/{platform}-tracking.js" defer></script>

RH Easy Data Layer

// Global for all pages
window.rhEasy = window.rhEasy || [];
window.rhEasy.push({
  platform: 'WOO_COMMERCE',
  conversionId: '123456789',
  conversionLabel: 'aaaa_bbbbb',
  fbPixelId: '123456789',
  pageType: 'product', // product | cart | checkout
});
    
// Product page only or on product variant changed
window.rhEasy.push({
    product: {
        productId: '1234',
        variantId: 'ab123',
        price: 29.99,
        currency: 'USD'
    }
});

// On `Add to Cart` event
window.rhEasy.push({
    cart: {
      items: [
        {
          productId: '1234',
          variantId: 'ab123',
          price: 29.99,
          currency: 'USD',
          quantity: 2
        }
      ]
    }
});

// Checkout page only
window.rhEasy.push({
    order: {
      items: [
        {
          productId: '1234',
          variantId: 'ab123'     
        }
      ],
      totalPrice: 99.99, //without shipping
      currency: 'USD',
      id: 1234
    }
});

Plugin uninstall

When user uninstalls/removes the plugin from the store GET https://goostav.roihunter.com/uninstall (GET https://goostav-staging.roihunter.com/uninstall for sandbox environment) endpoint should be called. Use custom header X-Authorization with value access_token stored in plugin state (set by /state endpoint) for authorization.