Skip to content

API.md

Latest commit

 

History

History
43 lines (24 loc) · 944 Bytes

API.md

File metadata and controls

43 lines (24 loc) · 944 Bytes
Raw

User Login

<email address and passowrd to perform the login operations.>

  • URL

    </api/signin>

  • Method:

    <POST>

  • URL Params

    <Requested parameters are email and password, they will be protect by the TLS layer>

    Required:

    email=[string]
    password=[string]

  • Data Params

    <Username and password parameters will by protected by the TLS layer.>

  • Success Response:

    <In case of success the request will be redirected to the dashboard page. Please see the dashboard success Response>

    • Code: 200
      Content: { id : 12 }

  • Error Response:

    <Error can be thrown either if the user does not exist, the password is wrong or the account has not been activated yet.>

    • Code: 200 OK
      Content: { error : "Log in" }

  • Notes:

    <Parameters are passed in clear, please remind to use this call over a TLS layer!>