Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nant1ng/rest-api_ecommerce
This is a school assignment. The assignment was about creating a REST API for E-commerce. I have only used plain PHP and no frameworks. The RESTful API will only return results in JSON and I have used CRUD principles.
https://github.com/nant1ng/rest-api_ecommerce
php rest-api
Last synced: 25 days ago
JSON representation
This is a school assignment. The assignment was about creating a REST API for E-commerce. I have only used plain PHP and no frameworks. The RESTful API will only return results in JSON and I have used CRUD principles.
- Host: GitHub
- URL: https://github.com/nant1ng/rest-api_ecommerce
- Owner: Nant1ng
- Created: 2021-03-20T16:44:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-11T21:02:01.000Z (almost 4 years ago)
- Last Synced: 2024-11-08T06:47:27.296Z (3 months ago)
- Topics: php, rest-api
- Language: PHP
- Homepage:
- Size: 84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# REST-API_E-commerce
- [Description](#description)
- [Endpoints](#endpoints)
- [Before using the code](#Before-using-the-code)
- [How to](#how-to)
---
## Description
#### This is a school assignment. The assignment was about creating a REST API for E-commerce. I have only used plain PHP and no frameworks. The RESTful API will only return results in JSON and I have used CRUD principles.
---
## Endpoints
### Users
---
#### POST - Create user
[](https://shields.io/)
>http://localhost/REST_API/V1/users/Create.php
### GET - Read all users
[](https://shields.io/)
>http://localhost/REST_API/V1/users/ReadAll.php
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
### Sessions
---
#### POST - Log in
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/sessions.php
#### PATCH - Refresh accesstoken
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/sessions.php?sessionid=(Your session id)
Use the same session id you got when logged in.
You need to put the accesstoken provided in header: Authorization = accesstoken.
#### DELETE - Log out
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/sessions.php?sessionid=(Your session id)
Use the same session id you got when logged in.
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
### Products
---
#### GET - Read products
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/products/ReadAll.php?(Page number)
Only 2 products per page, just to show that page nation works. Pagenumber can be 1 or 2 and so on.
---
#### GET - Read single product
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/products/Read.php?productid=(Product ID)
Product ID need to be an existing id.
---
#### POST - Create product
[](https://shields.io/)
>http://localhost/REST_API/V1/products/Create.php
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
#### DELETE - Delete product
[](https://shields.io/)
>http://localhost/REST_API/V1/products/Delete.php?productid=(Product ID)
Product ID need to be an existing id.
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
#### PATCH - Update product
[](https://shields.io/)
>http://localhost/REST_API/V1/products/Update.php?productid=(Product ID)
Product ID need to be an existing id.
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
### Cart
---
#### POST - Add product to cart
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/carts/Create.php?productid=(Product ID)
Product ID need to be an existing id.
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
#### DELETE - Delete product from cart
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/carts/Delete.php?productid=(Product ID)
Product ID need to be an existing id.
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
#### GET - Read cart
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/carts/Read.php
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
#### POST - Checkout cart
[](https://shields.io/) [](https://shields.io/)
>http://localhost/REST_API/V1/carts/Checkout.php
You need to put the accesstoken provided in header: Authorization = accesstoken.
---
## Before using the code
You need to follow this steps
> You need these programs for the API to work:
- Xampp or Mamp - Local database connection.
- Visual Studio Code or other code editor - To open or edit the code.
- Postman - To send requests.
> Download and use the API:
- Step 1 - Clone this repository.
- Step 2 - Start Xampp or Mamp and open phpMyAdmin.
- Step 3 - Use the SQL script included in the project to create database with the name rest_api.
- Step 4 - Open Postman and start making requests!.
---
## How to
Create users, sessions or products?
### Create Users:
You need to have Content-Type: application/json in header
```html
{
"fullname":"Your Name",
"email":"[email protected]",
"username":"Username",
"password":"Password"
}
```
---
### Create Sessions:
You need to have Content-Type: application/json in header
```html
{
"username":"Username",
"password":"Password"
}
```
---
### Create Products:
You need to have Content-Type: application/json in header
```html
{
"product_title":"Product Title",
"description":"Product Description",
"price":"Product Price",
"stock":"Y",
"img_url":"img-url"
}
```
---
---
## Success Response Examples
Show Examples
### User created:
``` html
{
"statusCode": 201,
"success": true,
"message": [
"User created, welcome Your Name"
],
"data": {
"user_id": "1",
"fullname": "Your Name",
"email": "[email protected]",
"username": "Username"
}
}
```
---
### Session created:
``` html
{
"statusCode": 201,
"success": true,
"message": [
"Logged in"
],
"data": {
"session_id": 1,
"access_token": "MzM2MzQ5MDk2MDYwNmFmYTBkMDBjMTY2NDRjNmRiNWM0MTQxOThkZDg1NjJkNWY4MTYxODE2OTEwNA==",
"access_token_expires_in": 3600,
"refresh_token": "MmU2ZTk1YmRiNDYyZjc2YWUyNzc0OWM3MTcwYjBkMzQ5MDkzNTM5YTIwNGZmMmIyMTYxODE2OTEwNA==",
"refresh_token_expires_in": 1209600
}
}
```
---
### Product created:
``` html
"statusCode": 201,
"success": true,
"message": [
"Product Created"
],
"data": {
"rows_returned": 1,
"product": [
{
"id": 1,
"product_title":"Product Title",
"description":"Product Description",
"price":"Product Price",
"stock":"Y",
"img_url":"img-url"
}
]
}
}
```
---
## Error Respons Examples
Show Examples
### Creating User Error:
``` html
{
"statusCode": 409,
"success": false,
"message": [
"Username or Email already exists"
],
"data": null
}
```
---
### Creating Sessions Error:
``` html
{
"statusCode": 400,
"success": false,
"message": [
"Username cannot be blank",
"Password cannot be blank"
],
"data": null
}
```
---
### Creating Product Error:
``` html
{
"statusCode": 400,
"success": false,
"message": [
"Product Price Error"
],
"data": null
}
```
---
[Back To The Top](#REST-API_E-commerce)