diff --git a/Home.md b/Home.md index 12ac41f..ad4c1ff 100644 --- a/Home.md +++ b/Home.md @@ -97,6 +97,33 @@ curl http://localhost:7811/health Bei Problemen bieten die Individual-Scripts jeweils eigene Troubleshooting-Sektionen. +## API Usage + +Furt bietet eine REST-API für die Integration mit Websites und Anwendungen: + +### Quick Start + +```bash +# Health Check (öffentlich zugänglich) +curl http://localhost:7811/health + +# Mail senden (API-Key erforderlich) +curl -X POST http://localhost:7811/v1/mail/send \ + -H "Content-Type: application/json" \ + -H "X-API-Key: your-api-key" \ + -d '{"name":"Test","email":"test@example.com","message":"Test message"}' +``` + +### Available Endpoints + +| Endpoint | Method | Authentication | Description | +|----------|--------|----------------|-------------| +| `/health` | GET | None | System health and status | +| `/v1/mail/send` | POST | Required | Multi-tenant mail service | +| `/auth/status` | GET | Required | Authentication verification | + +**→ [API Documentation](API-Documentation.md)** - Vollständige API-Referenz + ## Development Für lokale Code-Anpassungen nach Git-Installation: @@ -116,8 +143,6 @@ sudo ./install.sh --upgrade **→ [Development Setup](Development.md)** - In Planung -**→ [API Documentation](API-Documentation.md)** - In Planung - ## Current Status **v0.1.2 Features:** @@ -155,10 +180,11 @@ Furt ist aktuell ein integrierter HTTP-Server mit eingebautem Mail-Service (form - **[Installation Scripts](Installation-Scripte.md)** - Helper Scripts verstehen und nutzen - **[Konfiguration](Konfiguration.md)** - Config-System für Multi-Tenant-Setup -### Development & API -- **Development Setup** - In Planung -- **API Documentation** - In Planung -- **Contributing** - In Planung (aktuell kein Code-Rückfluss möglich) +### API & Development +- **[API Documentation](API-Documentation.md)** - Vollständige API-Referenz und Integration-Examples +- **[Mail Service API](Mail-Service-API.md)** - Detaillierte Mail-Service-Dokumentation +- **[Health Endpoint](Health-Endpoint.md)** - System-Monitoring und Diagnostics +- **Development Setup** - In Planung (lokale Code-Anpassungen) ### Support - **Helper Script Troubleshooting** - Jedes Installation-Script enthält eigene Fehlerbehebung