Client-side iframe integration

Display Nectar's utility connection page on your website for utility account connection

How it works

To allow your customers to connect online utility accounts, simply display the Nectar utility connection page with a signed magic link.

The magic link is a publicly accessible url that contains information about the company and site that is signed and encrypted by Nectar. Use the Nectar API's magic link endpoint to generate a signed magic link. Then you can embed this link into your website to display Nectar's utility connection page.

How the Nectar utility connection page appears on your website

How the Nectar utility connection page appears on your website

For information about potentially whitelabeling Nectar's platform or iframe, get in touch with our team.

Iframe Integration

The magic link follows the format:<company_id>/<nectar_signed_secret>

  • <company_id> is the id of the company that the utility account needs to be connected to (this typically is the client that your platform is serving). The company ids associated to a company can be queried from the Nectar API
  • <nectar_signed_secret> is an encoded string containing information about the associated company and site that is signed by a 128-bit AES encryption key. Without a valid secret, the magic link will be invalid and utility accounts cannot be connected

Then, simply display the iframe onto your website. Note that the Nectar works only on a desktop view, so similar dimensions are recommended for the iframe via a code block like the one below:

<iframe src="<company_id>/<nectar_signed_secret>"
        width="1152" height="648"