TL;DR - Swagger / OpenAPI compliant API documentation is available on Swaggerhub.
This page does not describe all functionalities that are exposed, rather gives you an overview of the minimal set to start get going with data product.
Backend to backend authentication uses client_id and client_secret (ie client credentials flow). The implementation is OAuth2 compliant, so your favourite OAuth2 package should support as from get-go.
curl -X POST [<https://api.gridio.energy/oauth2/token>](<https://api.gridio.energy/oauth2/token>) \\
-H "Content-Type: application/x-www-form-urlencoded" \\
-H "Authorization: Basic <base64(client_id:client_secret)>" \\
-d "grant_type=client_credentials&scope=scopes/backend"
With status codes we follow the universal convention, so in the following list should be nothing too exotic:
| Status Code | Description |
|---|---|
| 200 | Successful request |
| 400 | Bad request – likely due to an incorrect POST request body |
| 401 | Unauthorized – check the validity of your access token |
| 429 | Too many requests – rate limiting due to vehicle-related restrictions |
| 500 | Internal server error – unexpected issue on our end. If it persists, contact [email protected] |
Retrieve a user-specific token for launching the Gridio Connect UI:
GET <https://api.gridio.energy/api/v1/businesses/{business_id}/customers/token?user_id={user_id}>
See the Gridio Connect UI page for the full walkthrough.
Since integration creation is accomplished via Gridio Connect UI, only integration delete is required.
Delete customer integrations
curl -X DELETE <https://api.gridio.energy/api/v1/businesses/{business_id}/customers/{customer_id}/integrations> \\
-H "Authorization: Bearer <backend access token>"
Response status code 200 when successful.