...
Request Data
| Code Block |
|---|
|
{
'"email'": '"email@email.com'",
'"password'": '"password'"
} |
| Name | Type | Optional | Description |
|---|
| email | string | false | user's email who wants to log in |
| password | string | false | user password |
Response format and codes
| HTTP code | description |
|---|
| 200 | successful login |
| 401 | invalid login credentials |
...
On successful login, the service should return a response similar to this:
| Code Block |
|---|
|
{
'"user_token'": 'user_api_token' token,
"expiration_date": expiration_date
} |
On a failed login attempt the response is like the following example:
| Code Block |
|---|
|
{
'status': 'validation_error',
'field_errors': {
'field_name': 'validation error message',
'field_name#2': 'validation error message'
},
'global_errors': {
'error_key': 'error message',
'error_key#2': 'error message'
}
} |
Dependencies
...
"err": "invalid.login.credentials"
} |