An API application that stores an e-commerce's users, products and sales data. With the sales information (id) it is possible to register and get cashback for each sale, validating the cashback information at a third party API of a cashback company.
This is app is containerized
To properly run:
docker run -p 5000:5000 -d cashback_api_appTo start using the APP, first, you need to either register a new user or use the default admin user. This user need be used in order to login and enable most of the functionalities.
login: admin password: 12345
Method: POST
URL: http://0.0.0.0:5000/register_user
Header:
{'Content-Type' : 'application/json'}Body: {
'login' : 'admin',
'password' : '12345'
}Method: POST
URL: http://0.0.0.0:5000/login
Header:
{'Content-Type' : 'application/json'}Body: {
'login' : 'admin',
'password' : '12345'
}Response:
{'access_token': 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTY2MzM0MTc4NCwianRpIjoiZmIxMzAxYTYtYTQ3Zi00ZDFhLWJkNTgtMjgzOWFkZGE4YjUwIiwidHlwZSI6ImFjY2VzcyIsInN1YiI6MSwibmJmIjoxNjYzMzQxNzg0LCJleHAiOjE2NjMzNDI2ODR9.iunttkVbGRZ1sb6C1sUxuHdvsq5mNcnKcakaZXXxsgs'}You will need to copy this access token and use in your header in your future requests
Method: POST
URL: http://0.0.0.0:5000/logout
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'message' : 'You successfully logged out'}Register a new costumer of the store. Costumer ID (CPF) must be numeric with 11 digits
Method: POST
URL: http://0.0.0.0:5000/register_costumer
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Body: {
'costumer_id_cpf' : '12345678910',
'name' : 'Charles Darwin'
}Response:
{'message': "Costumer with id '12345678910' successfully created"}Method: GET URL: http://0.0.0.0:5000/12345678910
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'costumer_id_cpf': '12345678910',
'name': 'Charles Darwin'}Method: DELETE
URL: http://0.0.0.0:5000/12345678910
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'message': "Costumer with id '12345678910' successfully deleted"}Method: GET
URL: http://0.0.0.0:5000/costumers
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'costumers': [{'costumer_id_cpf': '12345678910', 'name': 'Charles Darwin'},
{'costumer_id_cpf': '10987654321', 'name': 'Alfred Russel Wallace'},
{'costumer_id_cpf': '66666666666', 'name': 'Richard Dawkins'},
{'costumer_id_cpf': '10203040506', 'name': 'Ernst Mayr'}]}Category: A product has to have one of the following categories: 'A', 'B', 'C'. These categories will dictate the cashback percentage over the value of the product
Value: product's value
Method: POST URL: http://0.0.0.0:5000/register_product
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Body: {
'category' : 'A',
'value' : 106.12
}Response: {
'message': "Product with id '1' successfully registered"
}Method: Get URL: http://0.0.0.0:5000/product/{id}
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'id': 12, 'category': 'B', 'value': 106.12}Method: GET
URL: http://0.0.0.0:5000/products
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{
{'products': [{'id': 1, 'category': 'C', 'value': 130.3},
{'id': 2, 'category': 'A', 'value': 11.3},
{'id': 3, 'category': 'A', 'value': 44.3},
{'id': 4, 'category': 'B', 'value': 130.3},
{'id': 5, 'category': 'B', 'value': 98.4},
{'id': 6, 'category': 'B', 'value': 17.7}
}Method: DELETE URL: http://0.0.0.0:5000/product/{id}
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'message': "Product with id '12' successfully deleted"}Costumer_id_cpf: id number of the costumer who purchased the sale
Products and quantities: A list of dictionaries with the id and quantities of the products purchased.
Method: POST URL: http://0.0.0.0:5000/register_sale
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Body: {
"costumer_id_cpf" : 12345678910,
"products_and_quantities" : [
{"id" : 5,
"quantity" : 10},
{"id" : 8,
"quantity" : 3}
]}Response: {'sale_id': 4,
'sale_date': '16/09/2022 10:11:42',
'costumer_id_cpf': 12345678910,
'products': [{'id': 5, 'category': 'B', 'value': 98.4, 'quantity': 10},
{'id': 8, 'category': 'C', 'value': 15.1, 'quantity': 3}],
'total': 1029.3}
}Method: GET URL: http://0.0.0.0:5000/sales/{sale_id}
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'sale_id': 3,
'sale_date': '15/09/2022 12:53:25',
'costumer_id_cpf': 12345678910,
'products': [{'id': 9, 'category': 'C', 'value': 15.9, 'quantity': 7},
{'id': 1, 'category': 'C', 'value': 130.3, 'quantity': 3}],
'total': 502.2}Method: GET
URL: http://0.0.0.0:5000/sales
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{
{'sales': [{'sale_id': 1,
'sale_date': '15/09/2022 12:50:58',
'costumer_id_cpf': 66666666666,
'products': [{'id': 1, 'category': 'C', 'value': 130.3, 'quantity': 2},
{'id': 3, 'category': 'A', 'value': 44.3, 'quantity': 4}],
'total': 437.8},
{'sale_id': 2,
'sale_date': '15/09/2022 12:51:58',
'costumer_id_cpf': 66666666666,
'products': [{'id': 4, 'category': 'B', 'value': 130.3, 'quantity': 5},
{'id': 6, 'category': 'B', 'value': 17.7, 'quantity': 2}],
'total': 686.9}
}Method: DELETE URL: http://0.0.0.0:5000/sales/{sale_id}
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'message': "Product with id '12' successfully deleted"}Cashback id: Unique id number automatically generated Cashback total: Total received in cashback api_response: Api generated by the third party api responsible for oficially registering the cashback
Method: POST URL: http://0.0.0.0:5000/register_cashback
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Body: {
"sale_id" : 2
]}Response: {'cashback_id': 1,
'cashback_total': 17.837999999999997,
'api_response': {'createdAt': '2022-09-15T13:03:00.816Z',
'message': 'Cashback criado com sucesso!',
'id': '32',
'document': 12345678910,
'cashback': 17.837999999999997},
'sale_id': 2}Method: GET URL: http://0.0.0.0:5000/cashbacks/{cashback_id}
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{'cashback_id': 1,
'cashback_total': 31.38,
'api_response': {'createdAt': '2022-09-14T21:11:02.539Z',
'message': 'Cashback criado com sucesso!',
'id': '38',
'document': 66666666666,
'cashback': 31.38},
'sale_id': 1}```
### GET ALL Cashbacks
Method: GET
URL: http://0.0.0.0:5000/cashbacks
```bash
Header:
{'Content-Type' : 'application/json',
'Authentication': Bearer access_token}Response:
{
{'cashbacks': [{'cashback_id': 1,
'cashback_total': 31.38,
'api_response': {'createdAt': '2022-09-14T21:11:02.539Z',
'message': 'Cashback criado com sucesso!',
'id': '38',
'document': 66666666666,
'cashback': 31.38},
'sale_id': 1},
{'cashback_id': 2,
'cashback_total': 34.35,
'api_response': {'createdAt': '2022-09-14T23:19:24.363Z',
'message': 'Cashback criado com sucesso!',
'id': '39',
'document': 66666666666,
'cashback': 34.35},
'sale_id': 2}
}For further examples, please access the test notebook: https://github.com/nnbuainain/cash_back_api_app/blob/master/consume_api_tests.ipynb