This project has reached it's end of life, as the API is not used anymore. It will not be maintained anymore and should not be used.
The project is intended to have a fun interaction with the Burp Suite and gather a deeper understanding inside how the API works.
This project is intended for informational and educational purposes! This product should not be used for any malicious purposes or harm!
To install the API, just clone the GIT repository with and install with NPM
git clone https://github.com/Elkozel/x-api
cd ./x-api
npm install .
Explains the basic terminology used by the API:
OnlineGroup contains Product contains Slot ... etc
The interfaces will be explained in a simple way, if you would like to see more information, please take a look at the code
| Interface name | Description |
|---|---|
| AvailableSpotsResponse | the usual response when all available slots are requested |
| Booking | a booking |
| DefaultErrorResponse | the expected response for an error returned from the server |
| DefaultResponse | the minimal response expected for a successful operation |
| OnlineGroup | an online group (e.g. "Tennis Courts", "Beach Volleyball Courts", "Fitness Time |
| OnlineGroupsResponse | the usual response when all online groups are requested |
| Product | a product (e.g. the different tennis courts, sports halls, etc.) |
| ProductByIdResponse | the usual response when a product by ID is retrieved |
| Slot | a slot (e.g. a slot from {time} to {time} for tennis court {number}) |
Same information as in the tsdoc:
| Function name | Description |
|---|---|
| addBooking | Adds a booking to the account of the user |
| addReservationBooking | Adds a reservation for the product on the specified slot |
| cancelBooking | Cancels a booking |
| checkVersion | Checks if the version of the API is complient with the current version |
| getAvailableSlots | Returns all available slots for a product on the specified date |
| getBaseJSON | Returns an Object with the minimal information required for a request plus the information from the additionally provided object |
| getProductById | Gets additional information about a product, based on its ID |
| getProductsByOnlineGroup | Gets all products by online group |
| myBookings | Retrieves all bookings of the customer |
For more information, please take a look at the procedures document.