Getting Started

Base URL

All requests should be made to the base url https://api.rolloff360.com with a valid authorization token.

Authorization: Bearer <access_token>

Authentication

Retrieve a valid access token by providing your application credentials to the authentication endpoint

Endpoint

POST https://auth.rolloff360.com/oauth/token

Parameters

NameTypeExample Value
client_idstringxPuQsWRGxJ4zOA0w4G3Fg6MD4FuTZ5dvr
client_secretstringWjiZVdIkuI4Sa_fqflb19-c5mRX8_s...
grant_typestringclient_credentials
audiencestringhttps://api.rolloff360.com

For additional help, see the Auth0 documentation.

Sample Response

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJh...",
  "expires_in": 36000,
  "token_type": "Bearer"
}

Responses

Status codes

The API returns HTTP status codes for every request.

CodeTextDescription
200OKSuccess.
400Bad RequestThe request failed. An accompanying error message contains more details.
500Server ErrorAn unhandled error has occured on the back end.

Error messages

If a 400 error occurs, the API will return a descriptive error message with additional information on why the error occurred. Multiple messages will be included if more than one error is identified in the request.

{
  "error": true,
  "message": [
    "material: Missing required field",
    "activityType: Expecting value type string, received: 10"
  ]
}