mirror of
https://github.com/DRYTRIX/TimeTracker.git
synced 2026-05-19 12:50:11 -05:00
Dries Peeters
9547937be2
- Simplify README version section and point to CHANGELOG - Update UI overview with Reports and installation reference - Refresh CONTRIBUTING, DEVELOPMENT, API.md links/consistency - Add ARCHITECTURE_AUDIT, DOCS_AUDIT, PRODUCT_UX_AUDIT, FRONTEND, PERFORMANCE - Add API_CONSISTENCY_AUDIT, RESPONSE_FORMAT, CONTRIBUTOR_GUIDE, TESTING_STRATEGY - Update GETTING_STARTED, REST_API, PROJECT_STRUCTURE, DEPLOYMENT_GUIDE
27 lines
1.2 KiB
Markdown
27 lines
1.2 KiB
Markdown
# API Documentation
|
|
|
|
Complete API reference for TimeTracker REST API.
|
|
|
|
## 📖 Overview
|
|
|
|
TimeTracker provides a comprehensive REST API for programmatic access to all features. The API supports token-based authentication and follows RESTful principles.
|
|
|
|
## 📚 Documentation
|
|
|
|
- **[REST API](REST_API.md)** - Complete API reference with all endpoints
|
|
- **[Response Format](RESPONSE_FORMAT.md)** - Standard error envelope and success/legacy response shapes
|
|
- **[API Token Scopes](API_TOKEN_SCOPES.md)** - Understanding token permissions and scopes
|
|
- **[API Versioning](API_VERSIONING.md)** - API versioning strategy and best practices
|
|
- **[API Enhancements](API_ENHANCEMENTS.md)** - Recent API improvements and additions
|
|
|
|
## 🔑 Quick Start
|
|
|
|
1. Create an API token in **Admin → Security & Access → Api-tokens** (or `/admin/api-tokens`)
|
|
2. Include the token in the `Authorization` header: `Bearer YOUR_TOKEN`
|
|
3. Make requests to the API endpoints
|
|
4. Review the [API Token Scopes](API_TOKEN_SCOPES.md) to ensure your token has the required permissions
|
|
|
|
## 📋 API Endpoints
|
|
|
|
See the [REST API](REST_API.md) documentation for a complete list of available endpoints organized by resource type.
|