Login
Each request in Traffilog API suite required a session token.
Session token can be received by calling the Login API with valid user and password
Request Parameters :
| Parameter Name | Type | Mandatory/Optional/Conditional |
|---|---|---|
| login_name | string | Mandatory |
| password | string | Mandatory |
Request Example :
{
"action": {
"name": "user_login",
"parameters": {
"login_name": "login_test",
"password": "password_test",
}
}
Response Parameters :
| Parameter Name | Mandatory/Optional | Description | |
|---|---|---|---|
| session_token | string | Mandatory | token to be used in any of the requests |
| profile_name | string | Optional | for future use |
| user_language | string | Optional | for future use |
| application_url | string | Optional | for future use |
| map_type | string | Optional | indicate the customer map type in traffilog system. valuse - "google" / "osm" (open street map) |
Response Example:
Success :
{
"response": {
"properties": {
"action_name": "user_login",
"data": [{
"session_token": "34C13A195C5E0044294380386",
"profile_name": "default",
"language": "",
"application_url": "",
"map_type": "osm"
}],
"action_value": "0",
"description": "",
"session_token": "34C13A195C5E0044294380386"
}
}
}
Failure :
{
"response": {
"properties": {
"action_name": "user_login",
"data": [{
"error_code": "999",
"error_description": "User name or passwrod are not valid"
}],
"action_value": "999",
"description": "User name or passwrod are not valid",
"session_token": "96B6F588620F4942A96A3F1F953EAC954294382328"
}
}
}
Action Values :
| action_value | description |
|---|---|
| 0 | Success |
| 999 | User name or passwrod are not valid |