| Object | Action | URL Route | Sample payload |
|---|---|---|---|
| Voluntario | list all | {}/voluntario | |
| Voluntario | create one of many | {}/voluntario | { "data":[{"nome": "ABC", "isActive":true},{"nome": "CDE", "isActive":false}]} |
| Voluntario | delete one | {}/voluntario/id/ | |
| Voluntario | list Voluntarios from the Backoffice source. Informative only. | {}/voluntario/fetch | |
| Voluntario | reload the local store from the Backoffice source. This would be triggered from a cron job or from an external request | {}/voluntario/reload | |
| Entrega | list all | {}/entrega | |
| Entrega | create one or many | {}/entrega | { "data":[{"local": "test1","qtd": "50"},{"local": "test2","qtd": "150"}]} |
| Entrega | delete one | {}/entrega/id/ |
Personal-notes style...not a comprehensive tutorial
Note: development under python 3.8.0
- Install Python 3.x
- Clone this project from Git
- Install dependencies from requirements.txt
- Run
- Install pyenv
-
- (mac) brew install pyenv-virtualenv
-
- (ubuntu) curl -L https://raw.githubusercontent.com/yyuu/pyenv-installer/master/bin/pyenv-installer | bash
- Install essentials if not there already
-
- apt-get install -y make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev
- Install Python 3.8.0
-
- pyenv install 3.8.0
- Confirm
-
- pyenv versions
- Create a virtual env for this purpose
-
- pyenv virtualenv 3.8.0 venv380
- Clone this project
-
- git clone git@github.com:pnmfonseca/3dmaskwebsiteapi.git
- Set the code folder's respective Python version
-
- cd 3dmaskwebsiteapi
-
- ~/3dmaskwebsiteapi# pyenv local venv380
-
- /3dmaskwebsiteapi# python -V -> Python 3.8.0
- Install requirements
-
- pip install -r requirements.txt
The following environment variables should be set:
| Name | Affects |
|---|---|
| MASK_LANDSCAPE | log file name, some config settings |
| MASK_CREDENTIALS | The database credentials (username:password) |
| MASK_TOKEN | The token that http requests must pass along in headers |
If not set, the app behaviour is set to sandbox
From the project's folder:
# python application.py
The application bootstraps:
(...)
03/29/2020 03:05:43 AM||WARNING||config.py||66||setupLogger()||Logging under darwin
03/29/2020 03:05:43 AM||WARNING||config.py||67||setupLogger()||Log file is [./3dmaskapi-sandbox.log]
03/29/2020 03:05:43 AM||WARNING||application.py||72||<module>()||=== Launching 3DMask Web API (sandbox) ===
Sample calls for this API (Bash environment variable)
export MASK_TOKEN="The-Token-that-the-server-expects"
EXPORT URL="https://your-domain-name"
Create the necessary table(s) if they do not exist
curl -H "Authorization: $MASK_TOKEN" -X POST $URL/createtables
Send multiple records to the server
curl -d '{ "data":[{"local": "test1","qtd": "50"},{"local": "test2","qtd": "150"}]}' -H "Content-Type: application/json" -H "Authorization: $MASK_TOKEN" -X POST $URL/entrega
List all stored records
curl -H "Authorization: $MASK_TOKEN" -X GET $URL/entrega