Skip to content

cnpem-emi/simar-api

Repository files navigation

SIMAR - API

Lint

SIMAR's REST API for notifications and more. Utilizes the Web Push API to push notifications to browsers.

For detailed information on endpoints and other documentation, check the OpenAPI docs.

Running (Docker)

docker-compose build
docker-compose up

Running

pip3 install -r requirements.txt
cd web
gunicorn --bind 0.0.0.0:5000 app:application 

Limitations

Due to anti-spam restrictions, please do not perform a large number of notifications every minute. That may cause the web push API endpoint to get deactivated, forcing the user to re-register a new subscription.