IGS Residential Solar API (v2)

This document describes how to use the IGS Solar API. It is intended for developers and IGS partners to utilize IGS Solar services without the front-end of the Solar360 website. All requests utilize HTTP and require authentication, as described below.

There are two environments available for developers utilizing the IGS Solar API, test and production. The test database will be periodically refreshed with production data - do not store anything within it that is critical to your operations.

Please contact IGS for the production and test endpoints.

The credentials for the production and test environments are different. You should've received both credentials when your initial API account was created.

Each individual user account for the API ties to a single Solar360 user. Permissions available to API users will be identical to those available to the user within the Solar360 application.

Authentication is handled via a header X-Api-Key. This field and the value (obtained from IGS) must be present on all API calls to authenticate and authorize the request for the appropriate resources.

curl example request:

curl <basePath>/api/v2/events --header "X-Api-Key: 123123123"

All endpoints require authorization.

The current version of this API is v2. This API will support non-current versions of the API from v2 forward. To access previous versions of the API, change the version number within the url as needed.

The API limits each individual user to a maximum of 30 requests per 30 seconds. When the number of requests exceeds the limit, requests will return the 429 - Too Many Requests HTTP error. This limit applies to both production and test environments.

There are limitations on the size, annual production and yield for systems created via this API. Those constraints are specific to states and utilities, available at the /api/v2/utilities endpoint.

• marketAnnualProductionCap - the system being created must have a total annual production less than this value.
• marketSystemSizeCap - the system must have a system size less than this value. System size is calculated by panelWattage x panelQuantity.
• marketYieldCap - the system must have a yield cap less than this value. Yield is calculated by annualProduction / systemSize.

HTTP status codes are used in all responses to the API. They give a broad indication of whether the request succeeded or failed. 2xx responses indicate success, anything else indicates a failure.

An Opportunity is an address where there is the opportunity for a sale. Opportunities will need to be assigned a customer to progress through the sales process.

A Customer is a person who is on the Title of the Opportunity Address who is expected to sign a contract or who has signed a contract. If one Customer fails the credit inquiry step, another Customer can be assigned to the Opportunity. Once a Customer has signed a contract, the Customer on the Opportunity cannot be changed.