Authentication API

Access Token

Request an OAuth 2.0 access token

Access tokens are currently valid for 7 days and should be re-used as much as possible. Please note the expires_in attribute in API responses and develop your authentication process around that value as much as possible. While we do not currently apply any specific rate limits to this API method, requesting excessive amounts of access tokens will get your application blocked.

Request

POST https://api.helios.earth/v1/oauth/token

Request Parameters

grant_type	`client_credentials` is required and is the only currently supported value.
client_id, client_secret	API key pair. Can alternatively be supplied as a base64-encoded string in the Authorization header of the request.

Response

HTTP 200

{
  "access_token": "...",
  "token_type":   "Bearer",
  "expires_in":   93600
}

View examples

Current User

Return a compact list of current token attributes, such as the token expiration date.

Request

GET https://api.helios.earth/v1/session

Response

HTTP 200

{
  "name":       "mycompany",
  "roles":      [],
  "context":    {},
  "expires_in": 93600
}