top of page

Embedded Portal Integration

Introduction

A JavaScript file and a DIV need to be added to the page where the portal will be displayed. The JavaScript file will generate an iFrame and add it within the DIV on the webpage. The DIV needs to cover 100% of the browser width to avoid any extra resizing.

Parameters

data-uid: Identifies the referral program. Provided by Aklamio.

data-width: The width of the Iframe, e.g.: "100%" or "800px" or "640“. (optional)

data-height: The height of the Iframe, e.g. “450px” or “212”. (optional)

Entrypoints

Link your entry-points to the referral portal by adding a simple link with tracking parameters to the entry-points on your website. These parameters used to track entrypoint performance are provided by Aklamio.

Code

/* Put this code in the <head> section of your site. */

<script type="text/javascript" src="https://api.aklamio.com/assets/embed/1.latest/embed.min.js">

</script>

/* Add the following DIV anywhere within the webpage layout where you want the Referral Portal to be created.*/

<div data-aklamio-embed="true" data-uid="<UID>"

</div>

Important note:

You will get your UID from the your dedicated Customer Success Manager.

​

If your IT policy prohibits the use of 3rd Party JavaScript, please contact your Aklamio Customer Success  manager. We can offer you the referral portal as stand-alone website.

Guide to setting up your custom subdomain with Aklamio

Introduction
Custom Subdomain Structure

Aklamio offers the option to host your referral or rewards portal under your own subdomain, ensuring a seamless brand experience for your customers. This guide outlines the necessary steps and requirements to set up and integrate your custom subdomain with Aklamio’s platform.

Your portal will be hosted on a subdomain within your domain, such as:

✅ Correct format: https://rewards.yourbrand.com/

❌ Not recommended: https://www.yourbrand.com/rewards

By following this structure, we ensure proper functionality and security of the hosted

portal.

Setup Process & Requirements

To enable subdomain hosting, the following steps must be completed:

1. Define the Subdomain

  • Decide on the URL structure for your program (e.g. rewards.yourbrand.com).

  • Confirm the subdomain with Aklamio before proceeding.

2. Aklamio Provides CNAME/DNS Records

  • Aklamio’s DevOps team will generate the necessary CNAME/DNS records.

  • These records will be shared with you to configure in your domain settings.

3. Point Subdomain to Aklamio’s Hosting on AWS

  • Your IT team needs to update your DNS settings to direct traffic to Aklamio’s

  • AWS infrastructure.

4. SSL Certificate Validation

  • To ensure secure connections, the SSL certificate must be validated.

  • You have two options for SSL certificate management:

    • ■ Option CA (Recommended): Aklamio manages the SSL certificate.

    • ■ Option CC: You manage the SSL certificate and provide it to Aklamio.

5. Final Confirmation & Go-Live

  • Once the DNS records are configured, inform Aklamio’s DevOps team.

  • Aklamio will complete the setup and confirm when your subdomain is live

Hosting Options & Turnaround Time

  • Option CA (Recommended): Aklamio manages the SSL certificate, simplifying the setup process.

  • Option CC: If you prefer to manage the SSL certificate yourself, the process requires you to configure one DNS record and provide the certificate to Aklamio.

Expected Turnaround Time:

  • Standard setup completion by Aklamio’s DevOps team takes 1 business day, provided that requests are limited to two customers per week. More requests may require additional processing time.

Fallback Options & Contingency Plans

  • If subdomain setup experiences delays, we recommend launching initially with an Aklamio-hosted URL (e.g., brand.aklamio.com).

  • In case of disruptions, such as an expired SSL certificate, Aklamio can temporarily redirect your program to an Aklamio-hosted fallback URL.

Next Steps

  1. Confirm your preferred subdomain with Aklamio.

  2. Choose between Aklamio-managed or customer-managed SSL certificate.

  3. Update your DNS settings based on the provided CNAME/DNS records.

  4. Notify Aklamio’s DevOps team once the setup is complete.

  5. Launch and start leveraging your branded referral or rewards portal!

For any questions or support, please contact Aklamio’s technical team.

bottom of page