Sandboxed utility accounts

To help your team get accustomed to our API and data models, Nectar provides a sandboxed utility account with mock data.

Sandboxed utility account connection

A way to continue testing the Nectar API with higher volumes of data in a trial environment is to use Nectar's sandboxed utility provider. Nectar's API will recognize this utility account:

Nectar Sandboxed Test Utility Account

When any different username and password combination is used, the resulting connection will have status as "INCORRECT_PASSWORD".

Sandboxed document and usage data

Whenever a sandboxed utility account connection with the correct credentials is connected to a company sample data will automatically be populated asynchronously (it may take up to 30 seconds). Sample document and associated meterSiteUsageData objects will be generated for the sandboxed account connection. This data can be immediately queried via the Get Documents by Connection endpoint using the connection's id.

Creating a sandboxed utility account connection via API

Since the sandboxed utility account uses basic username and password authentication (as opposed to MFA or two factor authentication), it can be connected via the API. Use the Create Basic Utility Account Connection endpoint to create a sandboxed utility account connection.

This endpoint will return the validated status of the utility account connection and the id of the utility account connection. If you ever forget the id, you can always lookup all the utility account connections for a company using Get Company Utility Account Connections .

Creating a sandboxed utility account connection via Magic Link.

The sandboxed utility account can also be connected via a magic link. After using the API to generate a magic link, use https://nectarclimate.com as the url when prompted for the utility provider's website. Then proceed by entering the sandboxed utility account credentials.

See the Magic links and iframe integration guide for more instructions on integrating.