API Docs

Authentication

Enter your credentials and receive a token to use in subsequent requests.

Log In

Authentication is performed on a per-user basis. A valid username/password combination results in a token that can be used to authorize subsequent API calls.

Once issued, a token is valid for 60 minutes. Submit a new login request to receive an updated token.

Authorization Headers

Requests are authorized through the Authorization HTTP header. The token from the login response must be used as value in the header.

Header Format Authorization: Bearer <token>

POST /account/<account-id>/meters/search HTTP/2
Accept-Encoding: gzip
Host: example.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoiOWIxODc2YzEtMTk5Yy00ZjRjLWJmYjEtNWZkMTEzM2M1MGJjIiwiYWNjb3VudF9pZCI6ImJjZjc1YWQ3LTE5OWMtMTk1NC1iZmIxLTVmZTExMzNhNTBiYyIsInBlcm1pc3Npb25zIjpbIlJlZ2lzdGVyTWV0ZXIiLCJHZXRNZXRlciIsIkRlbGV0ZU1ldGVyIiwiUGxhY2VCaWQiLCJHZXRCaWQiXSwiZXhwaXJhdGlvbl9kYXRlIjoiMjAxOC0wNy0wOVQxMzoxNjo0N1oifQ.6WQXgno7zU9lrn0IeZYMSoYGNTHUi26m6S5grSGHfEI

Token expiration

When the token expires, the refresh token (returned in the refresh_token field of the login response) can be used to request a new token at the /refresh_token endpoint. Alternatively, and probably easier to implement, is to do another login request for a new token.