Sandbox testing

For platform users: You can also create sandboxed connections through the connection wizard in the dashboard.

To help your team get familiar with the API and data models, Nectar provides a sandboxed utility account that generates mock data on connection. The examples below use v2.2, which is recommended for all new integrations.

Sandbox credentials

Use the following credentials when creating a sandbox connection. Any other username/password combination will result in an INCORRECT_PASSWORD status.

Field	Value
Utility provider URL	`https://nectarclimate.com`
Username	`nectar-sandbox-username`
Password	`nectar-sandbox-password`
Sites	An array of site IDs (at least 1, at most 3)
Country	`US` (or any two-letter country code)

Create a sandboxed connection

Create a company (if needed)

If you don’t already have a company, create one via the API. You’ll need the company id for subsequent requests.

curl -X POST 'https://external.nectarclimate.com/v2.2/company' \
  -H 'X-API-Key: YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Sandbox Test Company",
    "externalId": "sandbox-test-001"
  }'

import requests

response = requests.post(
    "https://external.nectarclimate.com/v2.2/company",
    headers={
        "X-API-Key": "YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
    json={
        "name": "Sandbox Test Company",
        "externalId": "sandbox-test-001",
    },
)
company = response.json()
print(company["id"])

Create sites

Create at least one site under your company. The site id is required when creating the connection.

curl -X POST 'https://external.nectarclimate.com/v2.2/company/{companyId}/site' \
  -H 'X-API-Key: YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Test Facility",
    "address": "123 Main St, San Francisco, CA 94105",
    "externalId": "site-001"
  }'

import requests

response = requests.post(
    f"https://external.nectarclimate.com/v2.2/company/{company_id}/site",
    headers={
        "X-API-Key": "YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
    json={
        "name": "Test Facility",
        "address": "123 Main St, San Francisco, CA 94105",
        "externalId": "site-001",
    },
)
site = response.json()
print(site["id"])

Create the sandbox connection

Create a utility connection using the sandbox credentials. Since the sandbox uses basic username/password authentication, it can be connected directly via the API.

curl -X POST 'https://external.nectarclimate.com/v2.2/company/{companyId}/connection' \
  -H 'X-API-Key: YOUR_SECRET_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "url": "https://nectarclimate.com",
    "username": "nectar-sandbox-username",
    "password": "nectar-sandbox-password",
    "sites": ["{siteId}"]
  }'

import requests

response = requests.post(
    f"https://external.nectarclimate.com/v2.2/company/{company_id}/connection",
    headers={
        "X-API-Key": "YOUR_SECRET_KEY",
        "Content-Type": "application/json",
    },
    json={
        "url": "https://nectarclimate.com",
        "username": "nectar-sandbox-username",
        "password": "nectar-sandbox-password",
        "sites": [site_id],
    },
)
connection = response.json()
print(connection["id"], connection["status"])

The response returns the connection id and validated status. You can look up all connections for a company at any time via GET /company/{companyId}/connection.

Query the generated data

Once connected with valid sandbox credentials, sample documents and usage data are populated asynchronously (up to 30 seconds). Query the data using the connection ID.

curl -X GET 'https://external.nectarclimate.com/v2.2/company/{companyId}/connection/{connectionId}/document' \
  -H 'X-API-Key: YOUR_SECRET_KEY'

import requests

response = requests.get(
    f"https://external.nectarclimate.com/v2.2/company/{company_id}/connection/{connection_id}/document",
    headers={"X-API-Key": "YOUR_SECRET_KEY"},
)
documents = response.json()
print(documents)

Using sandbox with invitations

The sandbox account can also be connected via a connection invitation. After creating an invitation through the API, use https://nectarclimate.com as the utility provider URL when prompted, then enter the sandbox credentials above. This is useful for testing the full end-user connection flow in your application. See Connection invitations for instructions on creating and embedding invitations.

Next steps

Connection invitations

Embed Nectar’s connection UI in your app

Webhooks

Get notified when connections and data change

Connection statuses

Understand connection lifecycle states

Developer onboarding

Integration patterns

API reference guides

Data model and methodology

Sandbox credentials

Create a sandboxed connection

Using sandbox with invitations

Next steps

Connection invitations

Webhooks

Connection statuses

​Sandbox credentials

​Create a sandboxed connection

​Using sandbox with invitations

​Next steps

Connection invitations

Webhooks

Connection statuses

Sandbox credentials

Create a sandboxed connection

Using sandbox with invitations

Next steps