Skip to content

api_documentation.md

Latest commit

 

History

History
215 lines (141 loc) · 2.62 KB

api_documentation.md

File metadata and controls

215 lines (141 loc) · 2.62 KB

Pinterest API

Users API

  1. Signup and get an auth token
POST /users/signup/
  1. Login a user and get an auth token
POST /users/login/
  1. Logout a user using the auth token
POST /users/logout/
  1. Get all users
GET /users/users/
  1. Get a user
GET /users/users/<int:user_id>/
  1. Partially update a user data
PATCH /users/users/<int:user_id>/
  1. Change user password
POST /users/users/changepassword/
  1. List all user relations
GET /users/relation/list
  1. Delete relations
DELETE /users/relation/delete
  1. List people whom the user follows
GET /users/relation/followed/<int:pk>
  1. List people who follow the user
GET /users/relation/follower/<int:pk>
  1. A logged-in user can view their own account data
GET /users/user-details/

Pin(s) API

  1. User can create a pin
POST /pins/api/v1/pins/
  1. User can view only their own pins
GET /pins/api/v1/user/pins/
  1. User can view pins that are in boards they created
GET /pins/api/v1/user/boards/pins/
  1. User can view all pins
GET /pins/api/v1/pins/
  1. Get pins of a board
GET /pins/api/v1/boards/<int:board_id>/pins/
  1. User can view a specific pin
GET /pins/api/v1/pins/<int:pin_id>/
  1. User can partially update a pin they made.
PATCH /pins/api/v1/pins/<int:pin_id>/
  1. pins Of Specific Category
POST /pins/api/v1/categories/pins/
  1. User can update a pin they made.
PUT /pins/api/v1/pins/<int:pin_id>/
  1. Pin authors only are the ones able to delete a pin they made.
DELETE /pins/api/v1/pins/<int:pin_id>/

Board(s) API

  1. User can create a board
POST /boards/api/v1/boards/
  1. User can view their own boards
GET /boards/api/v1/boards/
  1. User can view a specific board
GET /boards/api/v1/boards/<int:board_id>/
  1. User can partially update a board they made.
PATCH /boards/api/v1/boards/<int:board_id>/
  1. User can update a board they made.
PUT /boards/api/v1/boards/<int:board_id>/
  1. User can delete a board they made.
DELETE /boards/api/v1/boards/<int:board_id>/

Comment(s) API

  1. Get all comments on a pin
GET /comments/comment/
  1. Post a comment on a pin
POST /comments/comment/
  1. Get a comment
GET /comments/comment/<int:pk>
  1. Edit a comment
PATCH /comments/comment/<int:pk>
  1. Delete a comment
DELETE /comments/comment/<int:pk>