Ecommerce API

Documentation:

1. Django
2. Django Rest Framework
3. API Translation
4. Upload Package to Pypi

Installation:

-> you must install Elastic Search on your computer (you can use brew)

System Dependencies:

1. Install git on Linux:
   sudo apt-get install -y git
2. Clone or download this repo.
3. Install pip and virtualenv on Linux:
   sudo apt-get install -y virtualenv
sudo apt-get install -y python3-pip
4. Create a virtual environment on Linux or Mac:
   virtualenv -p python3 ec/.virtualenvs/ecommerce
5. Activate the virtual environment on Linux or Mac:
   source ec\.virtualenvs\ecommerce\Scripts\activate.bat
6. Install requirements in the virtualenv:
   pip3 install -r requirements.txt

Relational database dependencies (PostgreSQL):

1. Install components for Ubuntu:
   sudo apt-get update
sudo apt-get install python-dev libpq-dev postgresql postgresql-contrib

2. Switch to postgres (PostgreSQL administrative user):
   sudo su postgres

3. Log into a Postgres session:
   psql

4. Create database with name ecommerce:
   CREATE DATABASE ecommerce;

5. Create a database user which we will use to connect to the database:
   CREATE USER ecommerce_user WITH PASSWORD 'ecommerce_pass';

6. Modify a few of the connection parameters for the user we just created:
   ALTER ROLE ecommerce_user SET client_encoding TO 'utf8';
ALTER ROLE ecommerce_user SET default_transaction_isolation TO 'read committed';
ALTER ROLE ecommerce_user SET timezone TO 'UTC';

7. Give our database user access rights to the database we created:
   GRANT ALL PRIVILEGES ON DATABASE ecommerce TO ecommerce_user;

8. Exit the SQL prompt and the postgres user's shell session:
   \q then exit

9. Activate the virtual environment:
   source ~/.virtualenvs/ecommerce/bin/activate

10. Make Django database migrations: python manage.py makemigrations
    then: python manage.py migrate

Use admin interface:

1. Create an admin user:
   python manage.py dosuperuser
2. Run the project locally:
   `python manage.py runserver```
3. Navigate to: http://localhost:8000/admin/

Steps for install Celery and work it.

1. pip install -r requirements.txt
2. sudo apt-get install -y erlang
3. sudo apt-get install rabbitmq-server
4. sudo systemctl enable rabbitmq-server
5. sudo systemctl start rabbitmq-server to check if rabbitmq is working run: systemctl status rabbitmq-server
6. run local server for backend
7. run this command in new terminal in project path with activating virtual env: celery -A ecommerce worker -l info

Setup for Django Channels

1. Django Channels Deploy
2. Daphne
3. Django Channels configration on server

- if you face any problems on server pleas run these commands on production

1. sudo service supervisor stop
2. sudo service supervisor start
3. sudo supervisorctl reread
4. sudo supervisorctl update
5. sudo service nginx restart
6. sudo service apache2 restart

API Endpoints

Register

Method: POST
Endpoint: /registration/
Payload:
{ "username": "USERNAME", "first_name": "FIRST_NAME", "last_name": "LAST_NAME", "password1": "PASSWORD", "password2": "PASSWORD", "email": "OPTIONAL_EMAIL", "country": "COUNTRY_FULL", "phone_number": "CountryCode_PhoneNumber" }

Login

Method: POST
Endpoint: /login/
Payload:
{ "username": "USERNAME", "password": "PASSWORD" }

Logout

Method: POST
Endpoint: /logout/
Headers: Authorization: JWT YOUR_TOKEN_HERE

Password Change

Method: POST
Endpoint: api/password/change/
Headers: username: YOUR_USERNAME_HERE, password: YOUR_PASS_HERE
Payload:
{ "old_password": "OLD_PASSWORD", "new_password1": "NEW_PASSWORD1", "new_password2": "NEW_PASSWORD2" }

Password Reset

Method: POST
Endpoint: api/reset/password/
Payload:
{ "email": "EMAIL" }

User Addresses List

Method: GET
Endpoint: api/addresses/
Headers: username: YOUR_USERNAME_HERE, password: YOUR_PASS_HERE

User Address

Method: GET
Endpoint: api/addresses/<int:pk>
Headers: username: YOUR_USERNAME_HERE, password: YOUR_PASS_HERE

Create User Address

Method: POST
Endpoint: api/create/address/
Headers: username: YOUR_USERNAME_HERE, password: YOUR_PASS_HERE
Payload: { "country": "US", "city": "CITY", "district": "DISTRICT", "street_address": "STREET_ADDRESS", "postal_code": "POSTAL_CODE", "phone_number": "COUNTRYCODE_PHONENUMBER" }

FAQ

Method: POST
Endpoint: api/faq/topics/
Payload:
{ "title": "TOPIC/QUESTION", "text": "ANSWER" }

FAQ

Method: GET
Endpoint: api/faq/topics/

Reviews (NON-FUNCTIONAL)

Method: GET
Endpoint: api/reviews/

Reviews (NON-FUNCTIONAL)

Method: POST
Endpoint: api/reviews/
Payload:
{ "stars": "NUMBER(1-5)", "comment": "REVIEW", "product": "PRODUCT NAME", "user": "USER" }

Category

Method: GET
Endpoint: api/category/
Parameters: search=STRING, id=ID

Product List

Method: GET
Endpoint: api/list/product/
Parameters: search=STRING *(non-functional)*, id=ID, uuid=UUID, price=PRICE, color=COLOR, views=views

Product Detailed View

Method: GET
Endpoint: api/product/<str:uuid>/

Product Views

Method: POST
Endpoint: api/product/views/
Payload:
{ "ip": "IP_Address", "product_id": "PRODUCT_ID" }

Cart View

Method: GET
Endpoint: api/cart/ Headers: username: YOUR_USERNAME_HERE, password: YOUR_PASS_HERE

Cart Item View

Method: GET
Endpoint: api/cart-item/<str:id>/ Headers: username: YOUR_USERNAME_HERE, password: YOUR_PASS_HERE

GENERAL PARAMETERS FOR PRODUCTS: ?limit=NUMBER

Admin Credentials

Username: admin

Password: admin

For Dump and Load data

you should creating a folder to do this operations

for dump data from database:

python manage.py dumpdata products --format json --indent 4 > products/fixures/products.json

For loading data into database:

python manage.py loaddata products/fixures/products.json

dump and restoredatabase:

pg_dump dbname=ecommerce -f /tmp/ecommerce.psql

pg_restore -v --host= --port=5432 --username= --password --dbname=ecommerce /tmp/ecommerce.psql