Authorization

This api is responsible to authorize a user. It's also responsible to registed a new user and do some action relate to authorizaion.

Login User

Returns json data about the authorized user.

• URL

  /api/authorization/login

• Method:

  POST

• URL Params

  Required:

  None

• Data Params

        {
          "email": "[email protected]",
          "password": "123456",
          "isPersistent": "true"
        }
  

• Success Response:

  • Code: 200
    Content:

        {
          "email": "[email protected]",
          "fullName": "Amir Movahedi",
          "tagLine": "Think positively",
          "key": "38fc2758-1f96-435d-80ea-c7944037964d",
        }
    

• Error Response:

  • Code: 422 Unprocessable Entity
    Content:

        {
            "errors": [
                "Email address can't be null or empty.",
                "Password can't be null or empty.",
                "Email address or password is wrong."
            ]
        }
    

    OR

  • Code: 401 Unauthorized
    Content:

        {
            "errors": [
                "Email address or password is wrong.",
                "[email protected] user user is inactive.",
                "[email protected] user has been deleted."
            ]
        }
    

• Sample Call:

    axios({
    method: 'post',
    url: '/api/authorization/login',
    responseType: 'json',
    data: {
      email: '[email protected]',
      password: '123456',
      isPersistent": "true
    }
  })
  

  Signup User

Returns json data user key.

• URL

  /api/authorization/signup

• Method:

  POST

• URL Params

  Required:

  None

• Data Params

        {
          "email": "[email protected]",
          "fullName": "Amir Movahedi",
          "password": "123456",
          "confirmPassword": "123456"
        }
  

• Success Response:

  • Code: 200
    Content:

        {
            "key": "38fc2758-1f96-435d-80ea-c7944037964d"
        }
    

• Error Response:

  • Code: 422 Unprocessable Entity
    Content:

        {
            "errors": [
                "Full name can't be null or empty.",
                "Email can't be null or empty.",
                "Password can't be null or empty.",
                "Confirm password can't be null or empty.",
                "Password and confirm password should be equal."
            ]
        }
    

• Sample Call:

    axios({
    method: 'post',
    url: '/api/authorization/signup',
    responseType: 'json',
    data: {
      email: "[email protected]",
      fullName: "Amir Movahedi",
      password: "123456",
      confirmPassword: "123456"
    }
  })
  

  Logout User

Returns Ok status.

• URL

  /api/authorization/logout

• Method:

  GET

• URL Params

  Required:

  None

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    None

• Error Response:

  • Code: 403 Forbidden
    Content:

        {
            "errors": [
                "User is not authorized to logout."
            ]
        }
    

• Sample Call:

    axios({
    method: 'get',
    url: '/api/authorization/logout'
  })
  

Update User Password

Returns Ok status.

• URL

  /api/authorization/password

• Method:

  PUT

• URL Params

  Required:

  None

• Data Params

        {
          "newPassword": "123456",
          "confirmPassword": "123456"
        }
  

• Success Response:

  • Code: 200
    Content:

    None

• Error Response:

  • Code: 422 Unprocessable Entity
    Content:

        {
            "errors": [
                "New password can't be null or empty.",
                "Confirm password can't be null or empty.",
                "New password and confirm password should be equal."
            ]
        }
    

    OR

  • Code: 403 Unauthorized
    Content:

        {
            "errors": [
                "User is not authorized to update password."
            ]
        }
    

• Sample Call:

    axios({
    method: 'put',
    url: '/api/authorization/password',
    data: {
      newPassword: '[email protected]',
      confirmPassword: '123456'
    }
  })