Authentication
All calls to use a Content Type of application/json
Authentication can be optionally using either:
- Username and password, or
- oAuth2 Token protocol
Username and password is passed in clear text over SSL however oAuth is recommended for improved security.
End Points
Depending on your region, the end points for the API are as follows:
| US |
https://evoapius.tracker-rms.com/ |
| Canada |
https://evoapica.tracker-rms.com/ |
| UK (and Rest Of World) |
https://evoapi.tracker-rms.com/ |
To obtain an oAuth token, adopt the oAuth2 protocol, calling to the following address:
|
GET |
/oAuth2/Authorize |
Pass the following parameters
|
client_id |
“EvoApi_1.0” |
|
response_type |
“code” |
|
scope |
“read,write” |
|
redirect_uri |
Redirect Uri to pass back to |
|
state |
State string that will be passed back |
This will return a code back to the redirected uri provided with the following items:
|
code |
Authorisation code to be passed in the next step |
|
state |
State string provided in the first step to validate call |
|
POST |
/oAuth2/Token |
Pass the following parameters
|
client_id |
“EvoApi_1.0” |
|
redirect_uri |
Uri |
|
grant_type |
“authorization_code” or “refresh_token” |
|
client_secret |
Client secret (issued on request) |
|
code |
Authorisation code passed in the previous step |
|
refresh_token |
Redirect Uri from above |
This will return an oAuth Token for use in all subsequent calls
|
Token |
oAuth Token e.g. a124bf0d-4388-4a8e-a1a4-118a46221387 |
Please pass a “Bearer” header in all subsequent calls to the Widget API with the following
|
Bearer |
e.g. a124bf0d-4388-4a8e-a1a4-118a46221387 |
|
POST |
/api/widget/checkLogon |
You are able to pass the unique client API key (from TrackerRMS) and username (the user’s email address) to the api to check they are a valid user on start-up of your application, or pure oAuth details.
Sample Request:
{
"trackerrms": {
"checkLogon": {
"credentials": {
"username": "my.name@domain.com",
"password": "Welcome123",
"oauthtoken": "1bc7ca1e-8b9a-11e9-bc42-526af7764f64"
}
}
}
}
Sample Response:
{
"status": 0,
"message": "success",
"count": 0
}
Response status codes:
|
0 |
success |
|
1 |
user not found |
|
2 |
user not active |
|
99 |
Invalid request |