Organizable API

Welcome to Organizable-API. The back-end solution for your Organizable App 😎

Instructions

• Clone this repo on your local machine.
• Run bundle install
• Setup your datababase:
  • rails db:create
  • rails db:migrate
  • rails db:seed
• Start the server rails s

About the API

Endpoints

Here the list of available endpoints. The most important are marked with (*)

Manage users:

• POST /users
• GET /users/:id
• PATCH /users/:id
• DELETE /users/:id

Manage authentication:

• POST /login * This endpoint return your authentication token (required for everything else 👀)
• POST /logout

Manage boards:

• GET /boards * This endpoint return all the data needed to manage the actions on the Main page.
• POST /boards
• GET /boards/:id * This endpoint return all the data needed to manage the actions on the Board page.
• PATCH /boards/:id
• PUT /boards/:id
• DELETE /boards/:id

Manage lists:

• POST /boards/:board_id/lists
• PATCH /boards/:board_id/lists/:id
• DELETE /boards/:board_id/lists/:id

Manage cards:

• POST /lists/:list_id/cards
• GET /lists/:list_id/cards/:id
• PATCH /lists/:list_id/cards/:id
• DELETE /lists/:list_id/cards/:id

API Authentication

This API uses HTTP Authentication Token. Make a POST request to /login with the username and password of the test user created through the seed file:

{
  "username": "codeable",
  "password": "123456"
}

Since the username and password are valid, the server will return the user information with the authorization token:

{
  "id": 1,
  "username": "codeable",
  "email": "codeable@mail.com",
  "firstName": "User",
  "lastName": "Test",
  "token": "BNZ6hTF2xDya9AqUuvnu9x7i"
}

This token should be included on the headers for almost all the other endpoints, otherwise you will get an access denied error.

To include the token on your headers, add a key-value pair in this way:

• key: Authorization
• value: Token token="BNZ6hTF2xDya9AqUuvnu9x7i"