Installing the SDK JS File

Step 1 — Add the Script Tag

Add the HeldSway Affiliate SDK script to the section of main page on your website

<script src="https://s3.us-east-2.amazonaws.com/cdn.rentmy.co/affiliate/prod/affiliate-sdk.min.js"></script>

Step 2 — Get Your API Key

1. Go to your dashboard → Settings → API Keys
2. Click “+ Create Key”
3. Give the key a name (e.g., Production Integration)
4. Select the required scopes for your use case:

5. Click “Create Key” — copy and store your api_key securely

Step 3 — Initialize the SDK

Call init() on every page. It must be called first, before any other SDK methods.

<script>
(async function () {
  // Wait for SDK to be available
  await new Promise(function (resolve) {
    if (window.AffiliateSDK) return resolve();
    var interval = setInterval(function () {
      if (window.AffiliateSDK) {
        clearInterval(interval);
        resolve();
      }
    }, 50);
  });

  // Initialize with your API key
  await window.AffiliateSDK.init({
    apiKey: "as_XXXXYYYYZZZZ",   // Replace with your actual API key
    enablePageviews: true,        // Set to true to auto-track page views
  });
})();
</script>

⚠️ Security Note: Your apiKey (prefixed as_) is safe to use client-side. Never expose your api_secret in browser code.

SDK Method Reference