Login
POST/loginLogin a user to begin a user session. Once logged in, a session and session_token cookie will be returned. Pass these cookies in the request header for any subsequent API requests for actions using this current user session. User session tokens expire after 24 hours in which a Login request will have to be resubmitted to retrieve a new session.
Request
Body Params multipart/form-data
email
string <email>
required
Email address of the user
password
string <password>
required
Password for the user
Request samples
Responses
Login Success(200)
Accepted(202)
Invalid Credentials(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
meta
object
required
Object that contains the metadata of reseponse
code
integer
optional
HTTP status code of request
response
object
required
Response object
roles
array[string]
required
Contains the role of the logged in user. Will always only have 1 item.
Allowed values:
partnerpartner_viewcustom_partnerfleet_managergroup_managerusercustom_user
user
string
required
Email address of logged in user.
last_login
string <date-time>
required
Timestamp of last successful login of user
Example:
2024-01-01 13:40:14
user_id
integer
required
UID of user
session_expire
string <date-time>
required
Datetime when user session expires
Example:
2024-01-01 13:40:14
session_token
string
required
Session token
Example:
afced4feb4dc4c329abec784b2495243
result
enum<string>
required
"OK" if request successful, otherwise "Fail"
Allowed values:
OKFailed
Example
Login Success
{
"meta": {
"code": 200
},
"response": {
"roles": [
"fleet_manager"
],
"user": "Kianna_Cruickshank@hotmail.com",
"last_login": "1996-03-04 11:08:13",
"user_id": 7,
"session_expire": "2047-09-23 21:13:07",
"session_token": "afced4feb4dc4c329abec784b2495243"
},
"result": "OK"
}Last modified: a month ago