REST API Reference¶
Overview¶
SignBridge exposes a REST API under the api/ blueprint for programmatic access to users, rooms, and tokens. All endpoints require authentication.
Tokens¶
POST /api/tokens¶
Obtain an API token. Requires Basic Auth.
POST /api/tokens
Returns:
{"token": "your token here"}
DELETE /api/tokens¶
Revokw the current token. Requires Bearer Tokens
DELETE /api/tokens
Returns 204 Not content
Users¶
GET /api/users¶
Returns all registered users. Requires Bearer Token
GET /api/users
Returns:
{"items": [...], "total": 2}
GET /api/users/<id>¶
Returns a single user by ID. Requires Bearer Tokens
GET /api/users/1
Returns 404 if the user does not
Rooms¶
GET /api/rooms¶
Returns all rooms created in the system. Requires bearer Tokens
GET /api/rooms
Returns:
{"items": [...], "total": 5}
GET /api/rooms/<id>¶
Returns a single room by ID. Requires Bearer Tokens
GET /api/rooms/1
Returns 404 if the room does not exist.
GET /api/rooms/<id>/messages¶
Returns the messages sent in one particular room. Requires Bearer Tokens
GET /api/rooms/1/messages
Returns:
{"items": [...], "total": 10}
Error Responses¶
All errors return a JSON response in this format:
{"error": "bad request", "message": "..."}
Common status codes:
400— Bad request401— Unauthorized, invalid or missing credentials404— Resource not found429— Rate limit exceeded