← Back to home

📖 OneSlot API Documentation

🔐 Authentication

This service uses API keys for authentication with a granular permissions system.

Authentication methods:

HTTP Header: X-API-Key: your-api-key
URL Parameter: ?api_key=your-api-key

Available permissions:

calendar : Access to merged calendar
stats : Access to statistics
api_keys : API key management
sync : Force calendar synchronization

📥 Available endpoints

GET /calendar.ics 🔒 Permission: calendar

Returns the merged calendar in ICS format.

Example:
curl -H "X-API-Key: your-key" http://localhost:5000/calendar.ics
wget --header="X-API-Key: your-key" http://localhost:5000/calendar.ics

GET /stats 🔒 Permission: stats

Returns service statistics in JSON format.

Example:
curl -H "X-API-Key: your-key" http://localhost:5000/stats

GET /health 🔓 Public

Service health check (for monitoring).

Example:
curl http://localhost:5000/health

GET /api-keys 🔒 Permission: api_keys

List all API keys and their permissions (administration).

Example:
curl -H "X-API-Key: your-admin-key" http://localhost:5000/api-keys

POST /sync 🔒 Permission: sync

Force calendar synchronization and return status.

Example:
curl -X POST -H "X-API-Key: your-sync-key" http://localhost:5000/sync