Company endpoints

GET /api/companies

returns

[
  {
    "id": integer,
    "name": string,
    "address": string
  }
]

Tipper endpoints

GET /api/tippers

returns

[
  {
    "id": integer,
    "name": string,
    "photo_url": string,
    "email": string
  },
  {
    "id": integer,
    "name": string,
    "photo_url": string,
    "email": string
  }
]

GET /api/tipper/:id

returns

[
  {
    "name": string,
    "photo_url": string,
    "email": string
  }
]

DELETE /api/tipper/:id

returns

[
  {
    "name": string,
    "email": string
  }
]

PUT /api/tipper/:id

injest

    {
        "name": string:required,
    }

returns

[
  {
    "id": integer,
    "name": string,
    "photo_url": string,
    "email": string
  }
]

Tippee endpoints

GET /api/tippees/

returns

[
  {
    "id": integer,
    "name": string,
    "company": string,
    "photo_url": string,
    "start-date": integer,
    "email": string,
    "tagline": text,
    "qr_url": text
  },
  {
    "id": integer,
    "name": string,
    "company": string,
    "photo_url": string,
    "email": string,
    "tagline": text,
    "qr_url": text
  }
]

GET /api/tippees/:id

returns

[
  {
    "name": string,
    "email": string,
    "company": string
  }
]

PUT /api/tippeess/:id

injest

[
    {
    "name": string:required,
    "company": string,
    "company-address": string,
    "photo_url": string,
    "start-date": integer,
    "email": string,
    "tagline": text,
    "qr_url": text
    }
]

returns

[
    {
    "name": string:required,
    "company": string,
    "photo_url": string,
    "start-date": integer,
    "email": string,
    "tagline": text,
    "qr_url": text
    }
]

DELETE /api/tipper/:id

returns

[
  {
    "name": string,
    "email": string,
    "company": string
  }
]

Register endpoints

POST /api/register/tipper

injest

[
  {
    "id": integer,
    "name": string,
    "photo_url": string,
    "email": string
  }
]

POST /api/register/tippee

injest

[
  {
    "name": string:required,
    "company": string,
    "company-address": string,
    "photo_url": string,
    "start-date": integer,
    "email": string,
    "tagline": text,
    "qr_url": text
  }
]

Tipping endpoints

POST /api/tippee/:id/tips

injest

[
  {
    "tipper_id": integer,
    "amount": float
  }
]

MVP:

• roll our own authsystem

STRETCH IDEAS:

• OAUTH
• QR CODES
• STRIPE INTEGRATION
• GRAPH QL + REST API (dual system)