Skip to content
SynleapDevelopers
Log In for Tokens
API reference/Account & authentication

Log In for Tokens

Obtain an access token and refresh token using a username and password.

POSThttps://console.synleapenergy.com/open-api/v1/token/login
Scope
None
limit
30 / min globally; 10 / min per IP; 5 failed attempts for a username trigger a 15 min lock

Body parametersapplication/json

userNamestringRequired

Username, up to 64 characters.

passwordstringRequired

Password, up to 72 characters.

Usage notes

  • Access tokens are valid for 24 hours and refresh tokens for 90 days.

Responses

200Successful responseapplication/json
FieldTypeDescription
accessTokenstringAccess token used to call business endpoints.
refreshTokenstringRefresh token used to obtain new tokens.
accessExpiresAtintegerAccess token expiry in Unix epoch milliseconds.
refreshExpiresAtintegerRefresh token expiry in Unix epoch milliseconds.
4xx / 5xxError responseapplication/json
HTTP statusError codeDescription
400400Invalid login request. Check that userName and password are non-empty and within limits.
4031050041007visit-tenant-id is not allowed
4291050041008Rate limit exceeded; wait Retry-After seconds
4291050041010The account has more than 10 tokens at the same time.
4011050041014Login authentication failed
503500The service is temporarily unavailable. Try again later.
Synleap Open API · v1.1Last modified:

Synleap Help centre