Back-End

Snack vending machines in offices are the worst. They are stocked with snacks that either unhealthy or old and stale - and they are always in dire need of a restock. Nobody gets a say in which snacks are stocked or when they should be rotated or re-stocked. With Snackify - the office snack subscription service and app - send your office snacktime woes packing faster than Janet from HR did to your annoying cubicle-mate last week!

BaseURL

https://snackify7.herokuapp.com/

Endpoints

Authentication

Request Type	Endpoint	Description
POST	/auth/register/organization	Creates New Organization
POST	/auth/register/employee	Creates Employee
POST	/auth/login/organization	Creates JWT*
POST	/auth/login/employee	Creates JWT*

JSON Web Tokens Used to Verify Users

Changing the role of employee by employee ID (Only accessible to those with the role of orgAdmins and organizations)

Request Type	Endpoint	Description
PUT	/auth/:id/update-role	Changes role of an employee

Snacks

Request Type	Endpoint	Description
GET	/snacks	Return All Snacks
GET	/snacks/:id/nutrition	Return Nutrition By Snack ID
POST	/snacks/nutrition	Creates Nutrition Fact
POST	/snacks	Creates Snack
PUT	/snacks/:id	Updates a Snack by Snack ID
PUT	/snacks/:id/nutrition	Updates Nutrition Fact by Nutrition Fact ID
DELETE	/snacks/:id	Remove Snack By ID
DELETE	/snacks/:id/nutrition	Remove Nutrition Fact By Nutrition Fact ID

Subscriptions

Request Type	Endpoint	Description
GET	/subs	Return All Subscriptions
GET	/subs/:id/snacks	Return All Snacks For A Sub By Sub ID
POST	/subs	Adds New Subscription
PUT	/subs/:id	Update Subscription By Subscription ID
DELETE	/subs/:id	Remove Subscription By Subscription ID

Purchases

Request Type	Endpoint	Description
GET	/purchase	Return All Purchases
POST /purchase	Adds New Purchase
PUT	/purchase/:id	Update Purchase By Purchase ID
DELETE	/purchase/:id	Remove Purchase By Purchase ID

Requests

Request Type	Endpoint	Description
GET	/request	Return All Requests
POST	/request	Adds New Request
PUT	/request/:id	Update Request By Request ID
DELETE	/request/:id	Remove Request By Request ID

Data Models

Authentication

Register

A POST request to the /auth/register/organization endpoint expects to recieve an object as follows: (EVERY FIELD IS REQUIRED)

{
    "username": "username"
    "password": "password",
    "email": "email@address.com",
    "phoneNumber": "3453453534",
    "streetAddress": "124 Ross",
    "state": "Nowhere",
    "zipcode": "12345",
    "organizationName": "Org Name",
    "contactPerson": "Fake Person",
    "role": "organization"
}

A POST request to the /auth/register/employee endpoint expects to recieve an object as follows: (EVERY FIELD IS REQUIRED)

{
    "username": "username"
    "password": "password",
    "email": "email@address.com",
    "phoneNumber": "3453453534",
    "streetAddress": "124 Ross",
    "state": "Nowhere",
    "zipcode": "12345",
    "fullName": "Full Name",
    "contactPerson": "Fake Person",
    "role": "employee", // OR "orgAdmin"
    "orgId": Organization # goes here
}

Field	Type	Unique
username	String	true

Login

A POST request to the auth/login/organization endpoint expects to recieve an object as follows:

{
    "username": "username",
    "password": "happytree"
}

A POST request to the auth/login/employee endpoint expects to recieve an object as follows:

{
    "username": "username",
    "password": "happytree"
}

NOTE: If successful, a JSON Web Token will be returned. This must be stored and used as authentication for API calls to snacks, subscriptions and request endpoints.

A GET request to the auth/employees enpoint will return an object as follows:

[
    {
        "id": 1,
        "username": "jonbash2",
        "password": "$2a$10$Jk7zVyJU/wdgXvgNgxkIoOc4GT72OoQOH7ykmaHiGT8BT7rHxjtUi",
        "email": "jonbash@protonmail.com",
        "phoneNumber": "1234567890",
        "streetAddress": "124 Ross",
        "state": "Nowhere",
        "zipcode": "12345",
        "fullName": "Jon Bash",
        "contactPerson": "Jon Bash",
        "role": "Employee?",
        "orgId": 1
    },
    {
        "id": 2,
        "username": "jonbash3",
        "password": "$2a$10$GY1VaR9oTP2Wx/L3afjAJeXHh/xzcl6jm2J.vahOoFKcBtztkdQ8K",
        "email": "jonbash@protonmail.com",
        "phoneNumber": "1234567890",
        "streetAddress": "124 Ross",
        "state": "Nowhere",
        "zipcode": "12345",
        "fullName": "Jon Bash",
        "contactPerson": "Jon Bash",
        "role": "Employeeeeee?",
        "orgId": 1
    }
]

Changing the Role

A PUT request to /auth/:id/update-role endpoint will return an object as follows:

{   
    "id": 1
    "username": "username"
    "password": "password",
    "email": "email@address.com",
    "phoneNumber": "3453453534",
    "streetAddress": "124 Ross",
    "state": "Nowhere",
    "zipcode": "12345",
    "fullName": "Full Name",
    "contactPerson": "Fake Person",
    "role": "organization",
    "orgId": Organization # goes here
}

Getting all organizations

A GET request to /auth/organizations will return all organizations