README.md

Teen Quotes API

All API calls to endpoints require an access_token. Check the authentication section to know how to get one.

Authentication

• POST oauth Request an access_token for a user.
• POST oauth Get an access_token that identifies an application itself.
• POST oauth Refresh an access_token from a refresh_token.

Endpoints

Comments Resources

• GET comments/:quote_id Get information about comments posted on a quote.
• PUT comments/:id Update a comment.
• POST comments/:quote_id Create a new comment.
• DELETE comments/:id Delete a comment. The comment must have been posted by the logged in user.
• GET comments/:id Get information about a single comment.
• GET comments/users/:user_id Get comments posted by a user.

Countries Resources

• GET countries Get information about all countries.
• GET countries/:id Get information about a country.

FavoriteQuotes Resources

• POST favorites/:id Add a quote in the user's favorites.
• DELETE favorites/:id Remove a quote from the user's favorites.

Password Resources

• POST password/remind Ask for a reset password token.
• POST password/reset Reset a password using a reset token.

Quotes Resources

• GET quotes Get information about multiples quotes.
• POST quotes Submit a new quote.
• GET quotes/random Get information about multiples quotes randomly ordered.
• GET quotes/top_favorites Get information about the most favorited quotes, in a descending order.
• GET quotes/top_comments Get information about the most commented quotes, in a descending order.
• GET quotes/:id Get information about a single quote.
• GET quotes/favorites/:user_id Returns information about favorites quotes for a given user ID.
• GET quotes/:approved_type/:user_id Returns information about quotes for a given user ID and an approved quotes' status.
• GET quotes/search/:query Returns information about published quotes for a search query.

Users Resources

• POST users Create a new user.
• DELETE users Delete the logged in user.
• GET users Get information about the logged in user.
• GET users/:id Get information about a single user.
• PUT users/password Update the password of the user.
• PUT users/profile Update the profile of the user.
• PUT users/settings Update the settings of the user.
• GET users/search/:query Search users with a query based on their username. Returns only not hidden profiles.

Search Resources

• GET search/:query Search published quotes and users with a query of words. Users are displayed only if their profile is not hidden.

Stories Resources

• GET stories Get information about multiples stories.
• POST stories Create a new story.
• GET stories/:id Get information about a single story.

Support and bug reports

Contact Antoine Augusti at antoine.augusti@teen-quotes.com