Versions Compared

Old Version 27

changes.mady.by.user Unknown User (kn297)

Saved on

compared with

New Version 28

changes.mady.by.user Unknown User (ncl44)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL/api/login/
DescriptionLogin a user, and set cookie for authentication
MethodPOST
Url Param
Request Body Data
  1. HTML Form Submission with fields:
    1. email (string)
    2. password (string)
    3. remember_me (optional boolean)
  2. Alternatively, you can manually add following fields in request body as a json format:
    1. email (string)
    2. password (string)
    3. remember_me (optional boolean)
    4. formdata (empty string)
Response
  • {message: "Logged in."} - 200
  • {message: "Bad request format"} - 400
  • {message: "invalid credential(s) provided, please check your credential(s) and try again"} - 400/401
Cookie
  • session: a cookie for trace login status
  • remember_token: a cookie for remember_me feature (only when logged in with remember_me set to true)


URL/api/users/<email>/request-password-reset/
DescriptionRequest an email with a link and access token to reset password
MethodPOST
Url Paramemail
Request Body Data


Response
  • {message: "Password reset email has been sent."} - 200
  • {message: "There was a problem sending the password reset email. Please try again later"} - 500
Cookie



URL/api/users/<email>/resetpassword/
DescriptionRequest an email with a link and access token to reset password
MethodPOST
Url Paramemail
Request Body Data

A json format data
{
  "password":  "<string-password>"
}

Response
  • {message: "Successfully updated password."} - 200
  • {message: "Unauthorized: you do not have access to reset this user's password"} - 401
Cookie



URL/api/registration/
DescriptionRegister a new user.
MethodPOST
Url Param
Request Body Data
  1. HTML Form Submission with fields:
    1. email (string)
    2. username (string)
    3. password (string)
    4. password2 (string)
  2. Alternatively, you can manually add following fields in request body as a json format:
    1. email (string)
    2. username (string)
    3. password (string)
    4. password2 (string)
    5. formdata (!EMPTY! string)
Response
  • {message: "Registered, please login."} - 200
  • {message: "Data input is not valid, please try again"} - 400
Cookie


...