e-commerce-cms

API Demo:https://server-e-commerce-cms.herokuapp.com/

APP Demo :https://e-commerce-cms.web.app

Demo User => email: [email protected] | password:123

Content Management System for E-Commerce (Admin User)

RESTful endpoint for product's CRUD operation
JSON formatted response

RESTful endpoints

POST /register

Create new user

Request Header

not needed

Request Body

{
  "name": <your name>,
  "email": <your email>,
  "password": <your password>
}

Success Response:

Response (201 - Created)

{
  "id": <id>,
  "name": <your name>,
  "email": <your email >,
  "password": <your encrypted password>,
  "updatedAt": <date>,
  "createdAt": <date>
}

Error Response:

Response (400 - Bad Request)

[
  "message": <detail message>
]

Response (409 - conflict)

{
  "message": "Email Already registered!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

POST /login

Process Login

Request Header

not needed

Request Body

{
  "email": <your email>,
  "password": <your password>
}

Success Response:

Response (200 - Ok)

{
  "access_token": <your access token>
}

Error Response:

Response (400 - Bad Request)

[
  "message": <detail message>
]

Response (404 - Not Found)

{
  "message": "user not registered!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

POST /products

Create new product

Request Header

{
  "access_token": <your access token>
}

Request Body

{
  "name": <product name>,
  "description": <product description>,
  "category": <product category>,
  "price": <product price>,
  "stock": <product stock>,
  "image_url": <product image>,
},

Success Response:

Response (201 - Created)

{
  "id": <product id>,
  "name": <product name>,
  "description": <product description>,
  "category": <product category>,
  "price": <product price>,
  "stock": <product stock>,
  "image_url": <product image>,
  "UserId": <UserId>
},

Error Response:

Response (400 - Bad Request)

[
  "message": <message detail>
]

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

GET /products

Get User's products

Request Header

{
  "access_token": <your access token>
}

Request Body

not needed

Success Response:

Response (200 - Ok)

[
  {
    "id": <product id>,
    "name": <product name>,
    "description": <product description>,
    "category": <product category>,
    "price": <product price>,
    "stock": <product stock>,
    "image_url": <product image>,
    "UserId": <UserId>
  },
  {
    "id": <product id>,
    "name": <product name>,
    "description": <product description>,
    "category": <product category>,
    "price": <product price>,
    "stock": <product stock>,
    "image_url": <product image>,
    "UserId": <UserId>
  },
]

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

GET /products/:id

Get product by product's id

Request Header

{
  "access_token": <your access token>
}

Request Body

not needed

Success Response:

Response (200 - Ok)

{
  "id": <product id>,
  "name": <product name>,
  "description": <product description>,
  "category": <product category>,
  "price": <product price>,
  "stock": <product stock>,
  "image_url": <product image>,
  "UserId": <UserId>
},

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (403 - Forbidden)

{
  "message": "Forbidden access!"
}

Response (404 - Not Found)

{
  "message": "product not found! "
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

PUT /products/:id

Update product

Request Header

{
  "access_token": <your access token>
}

Request Body

{
  "name": <product name>,
  "description": <product description>,
  "category": <product category>,
  "price": <product price>,
  "stock": <product stock>,
  "image_url": <product image>,
},

Success Response:

Response (200 - OK)

{
  "id": <product id>,
  "name": <product name>,
  "description": <product description>,
  "category": <product category>,
  "price": <product price>,
  "stock": <product stock>,
  "image_url": <product image>,
  "UserId": <UserId>
},

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (403 - Forbidden)

{
  "message": "Forbidden access!"
}

Response (404 - Not Found)

{
  "message": "product not found! "
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

DELETE /products/:id

Update product

Request Header

{
  "access_token": <your access token>
}

Request Body

not needed

Success Response:

Response (200 - Ok)

{
  "id": <product id>,
  "name": <product name>,
  "description": <product description>,
  "category": <product category>,
  "price": <product price>,
  "stock": <product stock>,
  "image_url": <product image>,
  "UserId": <UserId>
}

Error Response:

Response (401 - Unauthorized)

{
  "message": "Not authenticated!"
}

Response (403 - Forbidden)

{
  "message": "Forbidden access!"
}

Response (404 - Not Found)

{
  "message": "product not found! "
}

Response (500 - Internal Server Error)

{
  "message": "Internal Server Error"
}

2maleek / e-commerce-cms_ Goto Github PK

e-commerce-cms_'s Introduction

e-commerce-cms

API Demo:https://server-e-commerce-cms.herokuapp.com/

APP Demo :https://e-commerce-cms.web.app

RESTful endpoints

POST /register

Success Response:

Error Response:

POST /login

Success Response:

Error Response:

POST /products

Success Response:

Error Response:

GET /products

Success Response:

Error Response:

GET /products/:id

Success Response:

Error Response:

PUT /products/:id

Success Response:

Error Response:

DELETE /products/:id

Success Response:

Error Response:

e-commerce-cms_'s People

Contributors

Watchers

Recommend Projects

Recommend Topics

Recommend Org