MyKitchen-PHP

This is the php API which the frontend of MyKitchen will talk to. A ? in a variable name means it is optional. In the case where all variables have ?, at least one of them is required.

Responses

Status Codes

status	meaning	extras
1	success
0	failure	error: tells you what went wrong, missing: tells you missing variable data

Endpoints

Users

POST users/create

variable	datatype	desc
user_name	string (50)	The unique username which will define a user: indy4ksu
user_pass	string (32, md5)	The md5'd password of a user. md5 this BEFORE sending
user_email	string (255)	The email address of a user: indy4ksu@gmail.com

GET users/select

variable	datatype	desc
id ?	int	The id of the user you want to get information on
username ?	int	The username of the user you want to get information on
email ?	int	The email of the user you want to get information on

Returns

{
  "status": 1,
  "data": [
    {
      "user_id": "4",
      "user_name": "nick",
      "user_pass": "2e315dcaa77983999bf11106c65229dc",
      "user_banner_url": "https://images.unsplash.com/photo-1706274072971-0d4bfb4c62c7?q=80&w=1932&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D",
      "user_email": "nick@zoty.us",
      "user_created_date": "2024-01-28 17:28:04"
    }
  ]
}

POST users/update

variable	datatype	desc
id	int	The id of the user you want to update
user_pass ?	string (32, md5)	The md5'd password of a user. md5 this BEFORE sending
user_email ?	string (255)	The email address of a user

POST users/delete

variable	datatype	desc
id	int	The id of the user you want to delete

Kitchens

POST kitchens/create

variable	datatype	desc
kitchen_owner_id	int	The id of the user who will own this kitchen
kitchen_name	string (100)	The title of the kitchen
kitchen_working_hours	json (100)	json object of the working hours for the kitchen
kitchen_uses_cash	string (yes/no)	Simple yes or no for if the kitchen uses cash
kitchen_uses_card	string (yes/no)	Simple yes or no for if the kitchen uses card

GET kitchens/select

variable	datatype	desc
id	int	The id of the kitchen you want to get information on
page ?	int	The page number of the results you want (default: 1), 25 kitchens per page

Returns

{
  "status": 1,
  "data": [
    {
      "kitchen_id": "5",
      "kitchen_owner": "4",
      "kitchen_name": "Deni's Cool Kitchen",
      "kitchen_is_active": "1",
      "kitchen_uses_cash": "0",
      "kitchen_uses_card": "0",
      "kitchen_created_date": "2024-01-29 21:52:10",
      "kitchen_working_hours": {
        "activeHours": {
          "monday": {
            "start": "09:00 AM",
            "end": "05:00 PM",
            "closed": false
          },
          "tuesday": {
            "start": "09:00 AM",
            "end": "05:00 PM",
            "closed": false
          },
          "wednesday": {
            "start": "09:00 AM",
            "end": "05:00 PM",
            "closed": false
          },
          "thursday": {
            "start": "09:00 AM",
            "end": "05:00 PM",
            "closed": false
          },
          "friday": {
            "start": "09:00 AM",
            "end": "05:00 PM",
            "closed": false
          },
          "saturday": {
            "start": null,
            "end": null,
            "closed": true
          },
          "sunday": {
            "start": null,
            "end": null,
            "closed": true
          }
        }
      }
    }
  ]
}

POST kitchens/update

variable	datatype	desc
id	int	The id of the kitchen you want to modify
kitchen_name ?	string (100)	The title of the kitchen
kitchen_working_hours ?	json (100)	json object of the working hours for the kitchen
kitchen_is_active ?	string (yes/no)	Simple yes or no for if the kitchen is taking orders or deactivated
kitchen_uses_cash ?	string (yes/no)	Simple yes or no for if the kitchen uses cash
kitchen_uses_card ?	string (yes/no)	Simple yes or no for if the kitchen uses card
kitchen_stripe_id ?	string (35)	Stripe Customer ID to be sent payments once handled by the system

POST kitchens/delete

variable	datatype	desc
id	int	The id of the kitchen you want to delete

Orders

POST orders/create

variable	datatype	desc
order_kitchen_id	int	The id of the kitchen the order was purchased from
order_user_id	int	The id of the user who purchased the order
order_products	json (1000)	json object of the products in the kitchen with product_id and product_price
order_total	float	Decimal value for the price of the order. total >= 0
order_status	string (sent / payment_waiting / in_progress / cooked / done)	One of the options specified which describes the order status

GET orders/select

variable	datatype	desc
id ?	int	The id of the order you want to get information on
kitchen_id ?	int	The id of the kitchen you want to get the orders of
user ?	int	The id of the user you want to get the orders of
page ?	int	The page number of the results you want (default: 1), 25 orders per page

Returns

{
  "status": 1,
  "data": [
    {
      "order_id": "1",
      "order_kitchen_id": "3",
      "order_user_id": "4",
      "order_products": [
        {
          "product_id": "2",
          "product_price": "6.9"
        },
        {
          "product_id": "1",
          "product_price": "5"
        }
      ],
      "order_total": "53.6",
      "order_status": "in_progress",
      "order_created_date": "2024-01-29 11:26:45"
    }
  ]
}

POST orders/update

variable	datatype	desc
id	int	The id of the order you want to update
order_products	json (1000)	json object of the products in the kitchen with product_id and product_price
order_total	float	Decimal value for the price of the order. total >= 0
order_status	string (sent / payment_waiting / in_progress / cooked / done)	One of the options specified which describes the order status

POST orders/delete

variable	datatype	desc
id	int	The id of the order you want to delete

Products

POST products/create

variable	datatype	desc
product_kitchen_id	int	The id of the kitchen who owns the product
product_title	string (255)	Title of the product
product_desc ?	string (1000)	Description of the product
product_price	float	Price of the product, number only
product_category ?	string (100)	The category the product belongs in
product_tags ?	string (500, csv)	The tags associated with the product, comma separated a-Z0-9
product_image ?	string (255)	The actual image to upload for the product (use media upload input)

GET products/select

variable	datatype	desc
id ?	int	The id of the product you want to get information on
kitchen_id ?	int	The id of the kitchen you want the products of
page ?	int	The page number of the results you want (default: 1), 25 products per page

Returns

{
  "status": 1,
  "data": [
    {
      "product_id": "2",
      "product_kitchen_id": "3",
      "product_title": "Pastrami Burger",
      "product_desc": "You get a pastrami ball it up put it on da grill burger it.",
      "product_price": "6.9",
      "product_category": "Handhelds",
      "product_tags": "pastrami,burger,cheese",
      "product_image_url": "https://indy-api.zoty.us/images/products/16973848741783f2afa6bed7b.jpg",
      "product_created_date": "2024-01-29 12:17:57"
    }
  ]
}

POST products/update

variable	datatype	desc
id	int	The id of the product you want to update
product_title ?	string (255)	Title of the product
product_desc ?	string (1000)	Description of the product
product_price ?	float	Price of the product, number only
product_category ?	string (100)	The category the product belongs in
product_tags ?	string (500, csv)	The tags associated with the product, comma separated a-Z0-9
product_image ?	string (255)	The new uploaded image for the product (unsplash)

POST products/delete

variable	datatype	desc
id	int	The id of the product you want to delete

Addresses

POST addresses/create

variable	datatype	desc
address_owner	int	The id of the user or kitchen
address_type	string (user / kitchen)	Tells if the address is for a user or kitchen
address_line1	string (100)	Address line 1
address_line2 ?	string (100)	Address line 2
address_city	string (50)	Address city
address_state	string (30)	Can be 2 letter code (GA) or full state name (Georgia)
address_zip	string (15)	Address zip code (30062)
address_phone	string (30)	Only if user: Phone number of the user

GET addresses/select

variable	datatype	desc
owner_id	int	The id of the user/kitchen you want to get the addresses of
address_type	string (user / kitchen)	the type of owner, is it a kitchen or a user?

Returns Kitchen

{
  "status": 1,
  "data": [
    {
      "address_id": "4",
      "address_owner": "3",
      "address_type": "kitchen",
      "address_line1": "308 Negra Arroyo Lane",
      "address_line2": "",
      "address_city": "Albuquerque",
      "address_state": "New Mexico",
      "address_zip": "87104",
      "address_phone": "",
      "address_created_date": "2024-01-29 21:06:07"
    }
  ]
}

User

{
  "status": 1,
  "data": [
    {
      "address_id": "3",
      "address_owner": "4",
      "address_type": "user",
      "address_line1": "308 Negra Arroyo Lane",
      "address_line2": "",
      "address_city": "Albuquerque",
      "address_state": "New Mexico",
      "address_zip": "87104",
      "address_phone": "871-908-3981",
      "address_created_date": "2024-01-29 21:06:07"
    }
  ]
}

POST addresses/update

variable	datatype	desc
id	int	The id of the address you want to update
address_line1 ?	string (100)	Address line 1
address_line2 ?	string (100)	Address line 2
address_city ?	string (50)	Address city
address_state ?	string (30)	Can be 2 letter code (GA) or full state name (Georgia)
address_zip ?	string (15)	Address zip code (30062)
address_phone ?	string (30)	Only if user: Phone number of the user

POST addresses/delete

variable	datatype	desc
id	int	The id of the address you want to delete

Delivery Methods

POST delivery_methods/create

variable	datatype	desc
kdm_owner	int	The id of the kitchen who owns the delivery method
kdm_type	string (local_pickup / delivery)	The options for the delivery type. Local pick-up means it is not a delivery.
kdm_range	int (0-255)	The mile range to allow people to order. If they are further away, then discourage them.

GET delivery_methods/select

variable	datatype	desc
id ?	int	The id of the delivery_method you want the information of
kitchen_id ?	int	The id of the kitchen you want to get the delivery methods of

Returns

{
  "status": 1,
  "data": [
    {
      "kdm_id": "4",
      "kdm_owner": "5",
      "kdm_type": "local_pickup",
      "kdm_range": "15",
      "kdm_created_date": "2024-01-30 13:56:46"
    }
  ]
}

POST delivery_methods/update

variable	datatype	desc
id	int	The id of the order you want to update
kdm_type ?	string (local_pickup / delivery)	The options for the delivery type. Local pick-up means it is not a delivery.
kdm_range ?	int (0-255)	The mile range to allow people to order. If they are further away, then discourage them.

POST delivery_methods/delete

variable	datatype	desc
id	int	The id of the delivery method you want to delete

Transactions

Stores the transactions for when a user buys something from a kitchen. Adding transaction amounts up gives the profits a kitchen has.

GET transactions/select

variable	datatype	desc
id ?	int	The id of the transaction you want the information of
kitchen_id ?	int	The id of the kitchen you want to get the transactions of
user_id ?	int	The id of the user you want to get the transactions of
page ?	int	The page number of the results you want (default: 1), 25 transactions per page

Stripe Payments

POST Stripe/ChargeCard

This also adds a record to the Transactions table. You can read from this table in a user or kitchen profile to display how their net credit/debit.

variable	datatype	desc
kitchen_id	int	The id of the kitchen to receive payment
user_id	int	The id of the user to be charged
card_number	int	The card number for payment (XXXX-XXXX-XXXX-XXXX)
card_name	str	The name on the card (JON DOE)
card_exp_m	int	The expiration month (XX)
card_exp_y	int	The expiration year (XXXX)
card_cvc	int	The card CVC code (XXX)
amount	float	The amount in dollars to charge

Password Reset

Send a password change request to a given user's email address. The user will need to use the code from their email to verify.

POST password_reset/request

This requests a password reset on the target email. If the email exists in the users database, they will be emailed with a 6 digit code. The password change request will be active for 5 minutes, if they do not reset their password in that time they will need to request again.

variable	datatype	desc
user_email	string	The id of the kitchen to receive payment

POST password_reset/change

This changes the password of a user if their reset code was correct. The password change request will be active for 5 minutes, if they do not reset their password in that time they will need to request again. The password needs to be md5'd or else once the user's password is changed, the user will not be able to log in.

variable	datatype	desc
user_email	string	The id of the kitchen to receive payment
reset_code	int	The 6-digit code the user received in their email
password	string (32, md5)	The md5'd password the user will be changed to.