API Reference
This documentation provides a detailed overview of all available API endpoints in the system. Each endpoint's purpose, method, URL, parameters, and response structure are described to facilitate integration and usage.
API Endpoints
POST Endpoints
-
Handle Card Session
- Endpoint:
/api/card - Method: POST
- Parameters:
RFID_Tag(string): Unique identifier for the RFID card.- Description: Processes session data associated with a card (RFID).
- Response Example:
1 2 3 4
{ "status": "success", "message": "Session processed successfully." }
- Endpoint:
-
Handle Device Address
- Endpoint:
/api/address - Method: POST
- Parameters:
device_id(string): Identifier for the device.address(string): Address details to be stored.- Description: Stores or updates the device address information.
- Response Example:
1 2 3 4
{ "status": "success", "message": "Device address updated successfully." }
- Endpoint:
-
Handle Heartbeat
- Endpoint:
/api/heartbeat - Method: POST
- Parameters:
device_id(string): Identifier of the device sending the heartbeat.- Description: Logs a heartbeat signal from a device.
- Response Example:
1 2 3 4
{ "status": "success", "message": "Heartbeat recorded successfully." }
- Endpoint:
-
Handle Device Connection
- Endpoint:
/api/connection - Method: POST
- Parameters:
device_id(string): Identifier of the connected/disconnected device.status(string): Status of the device (e.g., "connected", "disconnected").- Description: Registers the connection status of a device.
- Response Example:
1 2 3 4
{ "status": "success", "message": "Device connection status recorded." }
- Endpoint:
-
Add Session Data
- Endpoint:
/api/session - Method: POST
- Parameters:
UserID(int): User ID for session entry.CheckInTime(datetime): Time of check-in.CheckOutTime(datetime): Time of check-out.- Description: Records session data including check-in and check-out times for users.
- Response Example:
1 2 3 4
{ "status": "success", "message": "Session data recorded successfully." }
- Endpoint:
-
Handle Temperature Data
- Endpoint:
/api/temperature - Method: POST
- Parameters:
temperature(float): Temperature reading from the device.humidity(float): Humidity reading from the device.- Description: Stores temperature readings from devices.
- Response Example:
1 2 3 4
{ "status": "success", "message": "Temperature data recorded." }
- Endpoint:
-
Add New User
- Endpoint:
/api/add_user - Method: POST
- Parameters:
name(string): Name of the new user.role(string): Role of the user (e.g., "admin", "user").rfid_tag(string): RFID tag associated with the user.- Description: Adds a new user with associated RFID tag information.
- Response Example:
1 2 3 4
{ "success": true, "message": "User added successfully." }
- Endpoint:
-
Edit User
- Endpoint:
/api/edit_user - Method: POST
- Parameters:
userID(int): ID of the user to edit.name(string): Updated name of the user.role(string): Updated role of the user.rfid_tag(string): Updated RFID tag.- Description: Edits user details including name, role, and RFID tag.
- Response Example:
1 2 3 4
{ "success": true, "message": "User details updated." }
- Endpoint:
-
Delete User
- Endpoint:
/api/delete_user - Method: POST
- Parameters:
userID(int): ID of the user to delete.- Description: Deletes a user from the database.
- Response Example:
1 2 3 4
{ "success": true, "message": "User deleted." }
- Endpoint:
GET Endpoints
-
Get Connection Status
- Endpoint:
/api/connection - Method: GET
- Description: Retrieves connection status of all devices.
- Response Example:
1 2 3 4 5 6 7
{ "success": true, "connections": [ { "deviceId": "ESP32-001", "status": "connected" }, { "deviceId": "ESP32-002", "status": "disconnected" } ] }
- Endpoint:
-
Get Heartbeat Status
- Endpoint:
/api/heartbeat - Method: GET
- Description: Fetches latest heartbeat data from devices.
- Response Example:
1 2 3 4
{ "success": true, "heartbeat": "Device heartbeat status retrieved." }
- Endpoint:
-
Get Device Address
- Endpoint:
/api/address - Method: GET
- Description: Retrieves the address information of a device.
- Response Example:
1 2 3 4
{ "success": true, "address": "Device address retrieved." }
- Endpoint:
-
Get Latest Check-in
- Endpoint:
/api/latest_checkin - Method: GET
- Description: Returns the most recent check-in data.
- Response Example:
1 2 3 4
{ "success": true, "latest_checkin": { "UserID": "1", "CheckInTime": "2024-11-06 08:00" } }
- Endpoint:
-
Get Latest Connection
- Endpoint:
/api/latest_connection - Method: GET
- Description: Retrieves the latest connection status updates.
- Response Example:
1 2 3 4
{ "success": true, "latest_connection": { "deviceId": "ESP32-001", "status": "connected" } }
- Endpoint:
-
Get Latest Temperature
- Endpoint:
/api/latest_temperature - Method: GET
- Description: Fetches the latest temperature and humidity reading.
- Response Example:
1 2 3 4 5
{ "success": true, "temperature": "23.5", "humidity": "60" }
- Endpoint:
-
Get Temperature and Humidity Logs
- Endpoint:
/api/temperature_humidity - Method: GET
- Description: Retrieves the last 60 temperature and humidity records.
- Response Example:
1 2 3 4 5 6 7
{ "success": true, "data": [ { "timestamp": "2024-11-05 14:00", "temperature": "23.5", "humidity": "60" }, { "timestamp": "2024-11-05 13:00", "temperature": "22.8", "humidity": "58" } ] }
- Endpoint:
-
Get Leaderboard
- Endpoint:
/api/leaderboard - Method: GET
- Description: Provides a leaderboard based on user session data.
- Response Example:
1 2 3 4 5 6 7
{ "success": true, "leaderboard": [ { "UserID": "1", "name": "Alice", "totalPitchers": "5" }, { "UserID": "2", "name": "Bob", "totalPitchers": "4" } ] }
- Endpoint:
-
Get All Sessions
- Endpoint:
/api/session - Method: GET
- Description: Lists all session entries with details for each user.
- Response Example:
1 2 3 4 5 6
{ "success": true, "sessions": [ { "SessionID": "1", "UserID": "1", "CheckInTime": "08:00", "CheckOutTime": "17:00" } ] }
- Endpoint:
-
Get Time Registration Data
- Endpoint:
/api/time_registration - Method: GET
- Description: Retrieves time registration data for users.
- Response Example:
1 2 3 4 5 6
{ "success": true, "registrations": [ { "UserID": "1", "name": "Alice", "role": "admin" } ] }
- Endpoint:
-
Get Users
- Endpoint:
/api/users - Method: GET
- Description: Lists all users with role and RFID data.
- Response Example:
1 2 3 4 5 6
{ "success": true, "users": [ { "UserID": "1", "name": "Alice", "role": "admin", "RFID_Tag": "123456" } ] }
- Endpoint:
-
Get Cumulative Statistics
- Endpoint:
/api/cumulative_statistics - Method: GET
- Description: Provides cumulative statistics on sessions and users.
- Response Example:
1 2 3 4
{ "success": true, "cumulative_data": { "total_sessions": "10", "total_hours": "50" } }
- Endpoint:
-
Get Pitcher Statistics
- Endpoint:
/api/pitcher_statistics - Method: GET
- Description: Provides statistics about pitcher consumption, including total pitchers, money spent, and top consumers.
- Response Example:
1 2 3 4 5 6 7 8 9 10
{ "success": true, "pitcher_data": { "total_pitchers": "100", "total_money_spent": "1400", "pitchers_per_session": "2.5", "most_pitchers_session_date": "2024-11-01", "most_pitchers_in_session": "5" } }
- Endpoint:
-
Get Pitcher Consumption per User
- Endpoint:
/api/pitcher_consumption - Method: GET
- Description: Retrieves consumption data showing pitchers consumed per user.
- Response Example:
1 2 3 4 5 6 7
{ "success": true, "pitcher_consumption": [ { "name": "Alice", "total_pitchers": "10", "total_sessions": "5" }, { "name": "Bob", "total_pitchers": "8", "total_sessions": "4" } ] }
- Endpoint: