Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 764 Bytes

File metadata and controls

62 lines (42 loc) · 764 Bytes

Login

Used to login a registered user.

URL : /api/v2.0/login

HTTP Header :

Accept-Language: [language code]

Method : POST

Auth required : NO

Data constraints

{
  "username": "[username in plain text]",
  "password": "[password in plain text]"
}

Data example

{
  "username": "admin",
  "password": "foobarbaz"
}

Success Response

Condition : If 'username' and 'password' combination is correct.

Code : 200 OK

Content example

{
  "loggedin": true
}

Error Responses

Condition : If 'username' and 'password' combination is wrong.

Code : 400 BAD REQUEST

Content :

{
  "loggedin": false,
  "error": "Wrong username or password."
}