Skip to content

Backend API Routes

jane martin edited this page Jun 12, 2021 · 5 revisions

Readers

Reader Authentication

  • Log a reader in: POST/api/auth/login

  • Log a user out: GET/api/auth/logout

  • Sign a reader up: POST/api/auth/signup

Reader Preference CRUD

  • Create a new account with preferences: POST/api/readers/:reader_id/preferences

  • Get a single reader: GET/api/readers/:reader_id

  • Get a single reader's preferences: GET/api/readers/:reader_id/preferences

  • Update a single reader's preferences: PUT/api/readers/:reader_id/preferences

  • Delete a single reader's preferences: DELETE/api/readers/:reader_id/preferences

Reader Subscription CRUD

  • Get a single reader's subscription status: GET/api/readers/:reader_id/subscriptions

  • Create a new subscription for a single reader: POST/api/readers/:reader_id/subscriptions

  • Update a single reader's subscription: PUT/api/readers/:reader_id/subscriptions

  • Delete a single reader's subscription: DELETE/api/readers/:reader_id/subscriptions

Reader Account Management

  • Delete a single reader's account: DELETE/api/readers/:reader_id

Advisors

Advisor Authentication

  • Log an advisor in: POST/api/auth/advisor-login

  • Log an advisor out: GET/api/auth/logout

Advisor Dashboard

  • Get a list of all readers assigned to an advisor: GET/api/advisors/:advisor_id/readers

Future Routes

Advisor Order CRUD

  • Get a list of all orders assigned to an advisor: GET/api/orders/

  • Get a lit of products from which to curate orders: GET/api/products

  • Create a new order: POST/api/orders/

  • Update an existing order: PUT/api/orders/:id

  • Delete a single order: DELETE/api/orders/:id

Messages

Reader & Advisor CRUD

  • Get a list of all their messages: GET/api/messages

  • Create a new message: POST/api/messages/:id

  • Update an existing message: PUT/api/messages/:id

  • Delete a single message: DELETE/api/messages/:id