GraphQL API

https://graphql.org/learn/

GraphQL offers a powerful way to integrate many aspects of SolarPlus and build your custom integrations with any platform.

Setting up GraphQL access via IDE

If creating an integration via IDE you can set up a config file to manage access and add your User API token generated in SolarPlus under 'Integrations'.

{
  "name": "SolaPlus Live",
  "schemaPath": "schema.graphql",
  "extensions": {
    "endpoints": {
      "Default GraphQL Endpoint": {
        "url": "https://go.solarplus.co/graphql",
        "headers": {
          "user-agent": "JS GraphQL",
          "authorization": "Bearer ~add-token-here~"
        },
        "introspect": false
      }
    }
  }
}

Query the API

Create your query file

query Inventory($id: ID!) {
    Inventory(id: $id) {
        id
        name
        created
    }
}

Add argument variables, eg. ID
{ "id": 181043 }

Result:

{
"data": {
"System": {
"id": "181043",
"name": "9.6 kW Primo Telsa",
"created": "2021-06-25 04:34:14"
}
}

Querying the API via browser

Go to https://go.solarplus.co/graphql while logged into the app in another tab

Open the schema panel on the right to review the schema structure .

Query as per instructions on the left hand panel:

Sample JSON result:

SolarPlus Developers' Guide

GraphQL API

Analytics

Setting up GraphQL access via IDE

Query the API

Querying the API via browser

Related content