Bikenest
Introduction
This documentation refers to a student project "The AMOS project" of the Friedrich-Alexander University Erlangen-Nuremberg.
This API documentation is not really useful for any other use-case than for this specific project!
Overview
This API documentation is divided into two sub-systems. To fully understand what is going on here, please have a look on
Back to the two sub-systems, this API documentation is divided into
Backend Server Endpoints
Here you will find the "general" endpoints for the Backend System. It is the central control center of the whole software system. It gets calls from the frontend system (React Native App), connects to various databases and tells the RaspberryPis what do to with the hardware (Bikenests). If you do not understand this description, please have a look into the Architecture Description.
The backend API documentation is sub-divided into the following 4 Microservices which have their own API endpoints:
- Bikenest Service (e.g Here you can generate new Bikenests or get a list of all Bikenests)
- Booking Service (e.g. Handles reservations of a Bikespot or handles the (un)lock process)
- Payment Service (e.g. Sets and gets payment information in its respective DB)
- Usermanagement Service (e.g. Handles the user login and signup processes and connected logics)
Bikenest Service
The Bikenest Service itself has its own database which stores all information about each Bikenest.
Bikenest Controller
The endpoints in this Bikenest Controller are endpoints which are mainly used by the operator of the whole Bikenest-System. A user does not create a new Bikenest, but the operator should be able to. That is why does endpoints exist.