API Documentation

API - System endpoints

Availability check

Checks that the service is accessible, and that it can successfully connect to the database.

URL : /health

Method : GET

Auth required : NO

Permissions required : None

HTML/JSON : JSON

Success Response

Code : 200 OK

Content examples

copy{"status": "okay"}

JWT token generation

Gets a JWT authorization token if correct credentials are supplied

URL : /auth

Method : POST

Auth required : No

Permissions required : None

HTML/JSON : JSON

Data constraints

copy{
    "username": "...",
    "password": "..."
}

Success Responses

Condition : Data provided is valid and User is Authenticated.

Code : 200 OK

Content example : The response will be JSON formatted, and contain a key 'access_token'. The value is the token that must be in the Authorization header for each API request on a protected endpoint.

copy{
    "access_token": "ACCESSTOKENVALUE"
}

In this case, the HTTP header would be:

copyAuthorization: Bearer ACCESSTOKENVALUE

Error Response

Condition : If provided credentials are wrong.

Code : 401 Unauthorized

Content example :

copy{
  "errors": [
    {
      "title": "Bad username or password"
    }
  ]
}

JWT cookies

Sets and Unsets JWT cookies in the browser to authenticate requests.

URL : /login and /logout

Method : GET (to get login page or to log out)

Auth required : No

Permissions required : None

HTML/JSON : HTML only

Success Responses

Condition : Data provided is valid and User is Authenticated.

Code : 200 OK

Content example : A message will be at the top of the HTML view, denoting that the user has successfully logged in, and cookies are set.