API Endpoint

This is the web server for the biom-auth-iot project, part of the SCOC mention.

GET Routes

Endpoint	Description	Example JSON Response
/api/ping	Returns a simple JSON message indicating the server is responsive.	{ "message": "pong" }
/api/date	Returns the current date and time in UTC format.	{ "message": "2024-10-18 14:35:12" }
/api/logs	Returns the logs of /api/ident and /api/signing associated actions.	{"logs":[{"date":"2024-10-19 01:31:25","message":"test log"}]}

Endpoint	Description	Input JSON	Possible Responses
/api/check	Check if a initcode exists and return the remaining ident slot for that 'initcode'.	{ "initcode": "string", "room": "string" }	200 OK { "message": "remaining" } 401 Unauthorized
/api/ident	Registers a new identification for a user if their 'initcode' exists and if the user has fewer than 3 registered identifications for that 'initcode'.	{ "initcode": "string", "footprint": "string", "room": "string" }	200 OK 401 Unauthorized
/api/sign	Registers a new sign-in attempt based on an identification footprint.	{ "footprint": "string", "room": "string" }	200 OK 401 Unauthorized

POST /api/check:

POST /api/ident:

initcode (string): Unique user code that identifies the user.
footprint (string): A string representing the identification data or footprint.
room (string): The room identifier from which the request originates.

POST /api/sign:

POST /api/ping:

POST /api/date:

POST /api/check:

message (string): The amount of remaining ident slot for the asked initcode.

You can see those actions logs html live on the logs page