Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.53 KB

session.md

File metadata and controls

53 lines (36 loc) · 1.53 KB

Session

Endpoint Description
POST /users/sign_in Start a session
DELETE /users/sign_out End a session

POST /users/sign_in

Parameters
Name Required? Type Description
email Yes String Email for the user.
password Yes String Password for the user.
Example Request
curl -H "Content-Type: application/json" -d '{"email": "[email protected]", "password": "password"}' -X POST "http://recruiting-api.nextcapital.com/users/sign_in"
Example Response
{
    "api_token": "2FxozzbPWxzDTedCrixy",
    "email": "[email protected]",
    "id": 1,
    "todos": [1,2,3]
}

DELETE /users/sign_out

Parameters
Name Required? Type Description
user_id Yes String ID for the user.
api_token Yes String API token for this user's session.
Example Request
curl -H "Content-Type: application/json" -d '{"api_token": "some_token", "user_id": 1}' -X DELETE "http://recruiting-api.nextcapital.com/users/sign_out"
Example Response

Empty on success