Get started

Hello everyone, I'm Shahir I'm sharing my REST API's for Note app.

What you can expect from this ?

  • Note app with cloud backup.
  • Simple JWT token based content system.
  • Easy to understandable API

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

Sign Up

This is a sign up API. This API accept user input as form-data. Please check the picture bellow to understand more.

This API takes 2 form key

  1. name
  2. password

signUp Image

To get characters you need to make a POST call to the following url :
https://*************.com/api/sign-up

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

Login

This is a Login API. This API accept user input as form-data. Please check the picture bellow to understand more.

This API takes 2 ** form key **

  1. name
  2. password

signUp Image

To get characters you need to make a POST call to the following url :
https://*************.com/api/login

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

View All Todo

With this API user can view all notes that he/she created. This is a GET API.

Output Format

{
    "response": [
        {
            "completed": false,
            "description": "descFromPostman",
            "id": 1,
            "title": "titleFromPostman"
            },
            {
            "completed": false,
            "description": "descFromPostman2",
            "id": 2,
            "title": "titleFromPostman2"
            },
            {
            "completed": false,
            "description": "editDesc",
            "id": 3,
            "title": "edit"
            },
        ]
}


To get characters you need to make a GET request to the following url :
https://*************.com/api/view-all-todo

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

View Single Todo

With this API user can any notes that he/she created with the note ID. This is a GET API. In this api you neet to pass the note_id with the url to view the note.

Output Format

{
    "response": {
        "completed": false,
        "description": "descFromPostman2",
        "id": 2,
        "title": "titleFromPostman2"
}


To get characters you need to make a GET request to the following url :
https://*************.com/api/single-todo-view/{note_id}

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

Create New Todo

With this API user can create note. This is a POST API.

This API takes 2 form key

  1. title
  2. description

signUp Image

To get characters you need to make a POST request to the following url :
https://*************.com/api/new-todo

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

Update/Edit Todo

With this API user can edit previous notes that he/she created. This is a POST API.

This API takes 2 form key

  1. title
  2. description

signUp Image

To get characters you need to make a POST request to the following url :
https://*************.com/api/edit-todo/{note_id}

To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

Delete Todo

With this API user can delete any of the notes that he/she created. This is a POST API.


To get characters you need to make a POST request to the following url :
https://*************.com/api/delete-todo/{note_id}


To use this API, Please contact me at shahirislam7@gmail.com or tweet me on Twitter.

About Me

About me is going to update soon !!!