Skip to content

Backend Routes

Jump to bottom
Clipsey edited this page Sep 6, 2019 · 3 revisions

Backend Routes

HTML

  • GET / StaticPagesController#root

API Endpoints

users

  • GET /api/users - returns the channels of a given category, the channels a given user follows, or recommended home page channels, depending on request data. Also returns the channel tags associated with each channel.
  • POST /api/users - user sign up
  • GET /api/users/:user_id - get user information for a given channel, includes bio, viewers, tags, etc.
  • PATCH /api/users/ - updates the current user's bio information

session

  • POST /api/session - log in
  • DELETE /api/session - log out

categories

  • GET /api/categories - returns the categories for /directory, or the recommended categories, also returns the category tags associated with each category.
  • GET /api/categories/:id - returns category information, such as category picture and viewers.

channel followers

  • POST /api/followers/ - the current user follows a channel, creates a following
  • DELETE /api/followers/ - the current user deletes a following, specified by data payload
  • GET /api/followers/ - fetch the current user's followed channels

category followers

  • POST /api/category_followers/ - the current user follows a category, creates a following
  • DELETE /api/category_followers/ - the current user deletes a following, specified by data payload
  • GET /api/category_followers/ - fetch the current user's followed categories

Note: Users do not upload to another channel, the channel is the user. Users also do not upload through HTTP, but through RTMP and through an external program like OBS, as twitch.tv does.

Clone this wiki locally