Helpful links

• Deliverables
• Swagger URL: https://kj.webtrigon.com/workx/swagger/
• Redoc URL: https://kj.webtrigon.com/workx/redoc/

Project Setup

1. Clone the project
2. Create a virtual environment python3 -m venv virtualenv
3. Activate virtualenv source virtualenv/bin/activate
4. Run pip install -r requirements.txt
5. After installing run python manage.py makemigrations and python manage.py migrate
6. Post migration run python manage.py createsuperuser to create a user with Email ID and password of your choice
7. Execute python manage.py runserver

Auth API integration for the front-end

1. Pass Email ID {"email" : "<registered user email id>"} as a POST request to http://localhost:8000/workx/auth/email/
2. Since the backend will be locally connected to check the OTP visit the console on which you’re running the backend. The OTP/Token will be displayed along with the appropriate message.
3. Pass the OTP as POST request to http://localhost:8000/workx/auth/token/ {"email" : "<registered user email id>", "token": "<received OTP>"}
4. If the OTP matches the backend will provide a valid token

To Test the API on server

Please change the Base URL to https://kj.webtrigon.com/workx/ Ex: https://kj.webtrigon.com/workx/auth/email is the API you should ping if you need the OTP.

To get the list of users currently present

Please visit https://kj.webtrigon.com/workx/api/users/ You can also add the user with appropriate email ID before pinging the authentication APIs