Voots

Welcome to the voots API. You can make request to this API to get access to all our data.

API URL

Use this URL to access the API: https://voots.herokuapp.com

Authorization

We use JsonWebTokens in order to make our API secure. The following routes do not need a token:

• /users/login
• /users/register

If you want to make a request to a secure route, pass Bearer <your_jwt_token> for the header field of Authorization. You will receive a token upon login or register.

Example request

Here's an example request to /users/register in Swift:

// Create the parameters
let parameters = [
    "name": "John Appleseed",
    "email": "johnappleseed@info.com",
    "password": "john1234"
]
    
// Create the URL
let url = NSURL(string: "https://voots.herokuapp.com/users/register")
var request = URLRequest(url: url! as URL)
    
// Add the headers
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("application/json", forHTTPHeaderField: "Accept")
request.addValue("Bearer <my_json_token>", forHTTPHeaderField: "Authorization")
    
// Specify the http method
request.httpMethod = "POST"
    
// Create the json object
guard let httpBody = try? JSONSerialization.data(withJSONObject: parameters, options: JSONSerialization.WritingOptions.prettyPrinted) else {
    return
}

// Add the json to the request
request.httpBody = httpBody
    
// Open a URLSession
let session = URLSession.shared
session.dataTask(with: request) { (data, response, error) in
    // Safely unwrap the data
    if let data = data {
        do {
            let json = try JSONSerialization.jsonObject(with: data, options: [])
            print(json)
        } catch {
            print(error)
        }
    }
}.resume()

Routes

These are all the routes you can make requests to:

• /users
  • /register
    • POST
    • Parameters
      • email (String)
      • password (String)
      • name (String)
    • Creates the new user and returns a token and userId.
  • /login
    • POST
    • Parameters
      • email (String)
      • password (String)
    • Signs in the user and returns a token and userId.
  • /get
    • GET
    • Parameters
      • userId (String)
    • Returns the user object.
  • /delete
    • GET
    • Parameters
      • id (String)
    • Deletes the user from the database.
• /voots
  • /post
    • POST
    • Parameters
      • title (String)
      • body (String)
      • userId (String)
      • withGroupId (String)
    • Posts a voot.
  • /vote
    • PUT
    • Parameters
      • id (String) (id of the voot)
      • parameter "up" or "down" (String)
    • Votes on a voot.
  • /get
    • GET
    • Parameters
      • userId (String)
    • Returns the user's voots.
  • /all
    • GET
    • Parameters
      • userId (String)
    • Returns all the voots in the database.
  • /update
    • PUT
    • Parameters
      • userId (String)
      • title (String)
      • body (String)
      • id (String) (id of the voot)
    • Updates a voot.
  • /delete
    • DELETE
    • Parameters
      • id (String) (id of the voot)
    • Deletes a voot.
  • /group
    • POST
    • Parameters
      • userId (String)
      • groupId (String)
    • Returns a group's voots.
• /groups
  • /create
    • POST
    • Parameters
      • userId (String) (creator)
      • name (String)
      • users ([String]) (userId's of participants)
    • Creates a new group.
  • /get
    • GET
    • Parameters
      • userId (String)
    • Returns a user's groups.