Welcome to the Backend Dev Docs¶
The following documentation is aimed at getting developers up to speed with the technology stack and also the code of the backend of the football portal. This is not a user guide for the admin of the backend.
Overview¶
The backend provides a series of rest endpoints to search for players and create player reports. The rest api can be consumed by any mobile or browser based client.
It is implemented using Dango, Django Rest Framework and the Mysql database. It also uses Celery as a distributed task queue to handle the parallelisation of the tasks involved in generating a Player Report.
Both the development and production backend sites are hosted on the same server (IP: 52.209.30.148) and can be accessed via the following domains.
Development: http://dev.api.dectechsports.com/
Production: https://api.dectechsports.com/
API¶
- Login - HTTPS://api.dectechsports.com/authentication/login/
- Authentication - https://api.dectechsports.com:/authentication/user/
- List User’s Player Reports - https://api.dectechsports.com/user-reports
- Create Player Report (Maximum of 6 players) - https://api.dectechsports.com/create-report
- Search for players (by name, role, style, performance) - https://api.dectechsports.com/players
- Read User Report: (Get Request) - https://api.dectechsports.com/user-reports/<reportId>
- Search by similar player - https://api.dectechsports.com/players
Note - Additional Rest API endpoints exist for the Team Portal