reveaLA-API documentation

gistfile1.txt

API documentation
 
Open to all
 
POST /session
 logs user into session
 
  params:
    { 
     'session': {
       'email': ...
       'password': ...
      }
    }

  response:
    (with successful email + password)
      status: 200
      body: {
        'access_token': ...
        'token_type': 'bearer'
      }
  
 
POST /user
 creates a user
 
  params:
    { 
      'user': {
        'name': ...
        'username': ...
        'email': ...
        'password': ...
        'password_confirmation': ...
      }
    }
  
  response:
    on successful create:
      status: 201
      body: {
         'name': ...
         'username': ...
         'email': ...
         'spots': [...]
        }

    on failed create:
      status: 422
      body (example): {
        'email': 'is invalid'
        }
 
GET /spots
 show all spots of interest
  
  response
    [
      { 
        'spot_id': ...
        'name': ...
        'tag': ...
        'addresss': ...
        'latitude': ...
        'longitude': ...
      },
      { 
        'spot_id': ...
        'name': ...
        'tag': ...
        'addresss': ...
        'latitude': ...
        'longitude': ...
      },
      { 
        'spot_id': ...
        'name': ...
        'tag': ...
        'addresss': ...
        'latitude': ...
        'longitude': ...
      },
      ...
    ]
 
 
POST /closest
 gets next closest spot. if spot found and user logged in, saves found spot to user
 
  params:
  takes user current lat & lon, plus found spot_id (if any)
    { 
      'latitude': ...
      'longitude': ...
      'spot_id': ...
      'found_spots': [...]
    }
  
  response: 
  responds with next closest spot to user
    {
      'spot_id': ...
      'name': ...
      'tag': ...
      'address': ...
      'latitude': ...
      'longitude': ...
    }
    
Requires Access Token for all listed past this point
 
GET /user
 get logged in user's info
  
  response: {
         'name': ...
         'username': ...
         'email': ...
         'spots': [...]
  }
 
PUT or PATCH /user
 update logged in user info
  
  params:
    { 'user': {
      'first_name': ...
      'last_name': ...
      'email': ...
      'password': ...
      'password_confirmation': ...
      }
    }
 
  response:
    on successful update:
      status: 204
      no body
    on failed update:
      status: 422
      body (example): {
        'email': 'is invalid'
        }
        
DELETE /user
  delete currently logged in user
  response:
    status: 200
    body: none
 
POST /spots
  create a new spot
  params:
      { 
        "spot": {
           TO DO
          }
      }
  response: 
      {
        TO DO
      }

EVERYTHING ELSE

create new user:
curl -i -X POST -H "Content-Type:application/json" -d '{ "user": { "username": "username", "name": "this is my name", "email": "[email protected]", "password": "password1234", "password_confirmation": "password1234"}}' http://107.170.214.225/user

update existing user:
curl -i -X PATCH -H "Content-Type:application/json," -H "Authorization: Token authorization_token1234" -d '{ "user": { "username": "minor"}}' http://107.170.214.225/user

create new session:
curl -i -X POST -H "Content-Type:application/json" -d '{ "session": { "email": "[email protected]", "password": "masterpassword"}}' http://107.170.214.225/session

query for closest point based on user location:
curl -i -X POST -H "Content-Type:application/json" -d '{"spot_id":"1","latitude":"100", "longitude":"30"}' http://107.170.214.225/closest