Finance API is a REST API built with Flask & SQLAlchemy to operate CRUD operation on the database. The different routes are described below in the API Endpoint section.
User account is only available after the first login with User account authenticated with User JWT
- Allow user to create an account
- Allow user to login
- Allow user to disconnect
- Allow user to save information in the database
- Allow the user to update or delete their information (name, password, address, etc…)
- Allow user to delete their account
- Allow user to reset their password through Email
- Allow user to upload a profile picture
- Allow user to save setting in the database
- Allow user to update or delete their settings (theme, default currency)
Admin features are only available to Admin account authenticated with Admin JWT
- Allow admin to get a list of existing users
- Allow admin to update specific user information
- Allow admin to update specific user setting
- Allow admin to delete a specific user
- Allow admin to create specific user
After running the server, consult Documentation at :
Admin Endpoints:
-
Category
- Return JSON with all categories
- Post new category from JSON
- Return JSON selected category
- Update selected category from JSON
- Delete selected category
-
Product
- Return JSON with all products
- Post new product from JSON
- Return JSON selected product
- Update selected product from JSON
- Delete selected product
-
User
- Return JSON with all users
- Post new user and userdetail from JSON
- Return JSON selected user
- Update selected user and userdetail from JSON
- Delete selected user
-
UserDetails
- Return JSON with all userdetails
- Return JSON selected userdetail
-
Order
- Return JSON with all orders
- Post new order from JSON
- Return JSON selected order
- Update selected order from JSON
- Delete selected order
-
OrderDetails
- Return JSON with all orderdetails
- Post new orderdetail from JSON
- Return JSON selected orderdetail
- Update selected orderdetail from JSON
- Delete selected orderdetail
-
CartDetails
- Return JSON with all cartdetails
- Post new cartdetail from JSON
- Return JSON selected cartdetail
- Update selected cartdetail from JSON
- Delete selected cartdetail
-
Delivery
- Return JSON with all deliveries
- Post new delivery from JSON
- Return JSON selected delivery
- Update selected delivery from JSON
- Delete selected delivery
-
Payment
- Return JSON with all payments
- Post new payment from JSON
- Return JSON selected payment
- Update selected payment from JSON
- Delete selected payment
User Endpoints:
-
User Auth Management
- Return JSON with Access TOKEN
- Send Email set Password
- Send Email set Password
- Set/Update password
-
User CRUD
- Return JSON with user and userdetails
- Update selected user from JSON
- Delete selected user
-
UserDetails CRUD
- Return JSON with all userdetails for user
- Add userdetails to user
- Get selected userdetail
- Update selected userdetail from JSON
- Delete selected userdetail
-
Orders / Carts / Products / Category CRUD
- Return JSON with categories
- Return JSON with products
- Return JSON with single product
- Return JSON with orders for user
- Return JSON with cart for user
- Add to Cart for user
Database schema:
Project is created with:
- python V3.9.0
- astroid V2.4.2
- bcrypt V3.2.0
- blinker V1.4
- certifi V2020.12.5
- cffi V1.14.4
- chardet V4.0.0
- click V7.1.2
- colorama V0.4.4
- Flask V1.1.2
- Flask-Bcrypt V0.7.1
- Flask-Cors V3.0.9
- Flask-JWT-Extended V3.25.0
- Flask-Mail V0.9.1
- Flask-SQLAlchemy V2.4.4
- gunicorn V20.0.4
- idna V2.10
- isort V5.6.4
- itsdangerous V1.1.0
- Jinja2 V2.11.2
- lazy-object-proxy V1.4.3
- MarkupSafe V1.1.1
- mccabe V0.6.1
- psycopg2 V2.8.6
- pycparser V2.20
- PyJWT V1.7.1
- pylint V2.6.0
- requests V2.25.1
- six V1.15.0
- SQLAlchemy V1.3.20
- stripe V2.55.1
- toml V0.10.2
- urllib3 V1.26.2
- Werkzeug V1.0.1
- wrapt V1.12.1
$ git clone https://github.com/antoineratat/api_shop.git
$ py -3 -m venv venv
$ source venv\bin\Activate
$ cd shop_api
$ pip install -r requirements.txt
$ SECRET_KEY = '12345678912345678912345678912312'
$ JWT_SECRET_KEY = '12345678912345678912345678912312'
$ DATABASE_URL = 'postgres://myurl:port/dbname'
$ MAIL_USERNAME = '[email protected]'
$ MAIL_PASSWORD = 'mailpassword'
$ MAIL_PORT = 'mailport'
$ MAIL_SERVER = 'mailserver'
$ MAIL_USE_TLS = 'usetls'
$ SRIPE_API_KEY = 'stripekey'
$ venv\Script\Activate
$ python
$ from run import db
$ db.create_all()
$ exit()
$ python run.py