hxghhhh/mecca

Identity Service 1.0 for vagrance suite

Introduction

This is the prototyping docs made for uRyde API endpoints, which will allow you to post rides and get rides in our database

We currently own have docs the shell scripts up, but hope to have other languages soon

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: <ApiKey>"

Make sure to replace <ApiKey> with your API key.

Rides

Get All Rides

curl http://localhost:3000/api/rides

The above command returns JSON structured like this:

[
  {
    "departure_location": "3394 SW 342th Ave. San Francisco, CA 33029",
    "departure_longitude": 23.46,
    "departure_latitude": 56.16,
    "departure_time": "11-06-2016 5:00 pm",
    "arrival_location": "213 Johnson St. Apt 2 San Jose, CA 34323",
    "arrival_longitude": 23.46,
    "arrival_latitude": 56.16,
    "seats_available": 5,
    "created_by": "<user.id>",
    "one_way": true
  },
  {
    "departure_location": "another location",
    "departure_longitude": 23.46,
    "departure_latitude": 56.16,
    "departure_time": "11-06-2016 5:00 pm",
    "arrival_location": "another location",
    "arrival_longitude": 23.46,
    "arrival_latitude": 56.16,
    "seats_available": 5,
    "created_by": "<user.id>",
    "one_way": true
  }
]

This endpoint retrieves all rides.

HTTP Request

GET http://example.com/api/rides

Create a Ride

curl http://localhost:3000/api/rides
-H "Content-Type:application/json"
-X POST
-d '{
      "departure_location": "20 Rue Barbette, 75003 Paris, France",
      "arrival_location": "Champ de Mars, 5 Avenue Anatole France, 75007 Paris, France",
      "departure_time": "01-01-1915 11:23 pm",
      "seats_available": 3,
      "created_by": "<user.id>"
    }'

The above command returns JSON structured like this:

  {
    "departure_location": "3394 SW 342th Ave. San Francisco, CA 33029",
    "departure_longitude": 23.46,
    "departure_latitude": 56.16,
    "departure_time": "11-06-2016 5:00 pm",
    "arrival_location": "213 Johnson St. Apt 2 San Jose, CA 34323",
    "arrival_longitude": 23.46,
    "arrival_latitude": 56.16,
    "seats_available": 5,
    "created_by": "<user.id>",
    "one_way": true
  }

This endpoint allows users to create rides and POST to board.

HTTP Request

GET http://example.com/api/rides