API-Dokumentation
Vollständige Referenz für die Natureware REST API
Einführung
Die Natureware API ermöglicht den programmatischen Zugriff auf Gewässerdaten, Messwerte und Analysen. Die API folgt REST-Prinzipien und verwendet JSON für Anfragen und Antworten.
Basis-URL
https://api.natureware.de/api/v1/Antwortformat
Alle Antworten werden im JSON-Format zurückgegeben. Erfolgreiche Anfragen geben einen HTTP-Statuscode 2xx zurück, Fehler werden mit entsprechenden 4xx oder 5xx Codes signalisiert.
Authentifizierung
Die API verwendet API-Keys zur Authentifizierung. Fügen Sie Ihren API-Key im Authorization-Header jeder Anfrage hinzu:
curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.natureware.de/api/v1/waterbodiesAPI-Key sicher aufbewahren
Teilen Sie Ihren API-Key niemals öffentlich. Verwenden Sie Umgebungsvariablen, um den Key in Ihrer Anwendung zu speichern.
Gewässer
Endpunkte für Gewässer-Daten
Gibt eine Liste aller Gewässer zurück
Beispiele
curl -X GET "https://api.natureware.de/api/v1/waterbodies" \ -H "Authorization: Bearer YOUR_API_KEY"Gibt Details zu einem bestimmten Gewässer zurück
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
id | uuid | path | required | Die eindeutige ID des Gewässers |
Beispiele
curl -X GET "https://api.natureware.de/api/v1/waterbodies/550e8400-e29b-41d4-a716-446655440001" \ -H "Authorization: Bearer YOUR_API_KEY"Messwerte
Endpunkte für Messwert-Daten
Gibt Messwerte für ein Gewässer zurück
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
id | uuid | path | required | Die eindeutige ID des Gewässers |
start_date | date | query | optional | Startdatum für den Zeitraum (YYYY-MM-DD) |
end_date | date | query | optional | Enddatum für den Zeitraum (YYYY-MM-DD) |
Beispiele
curl -X GET "https://api.natureware.de/api/v1/waterbodies/550e8400-e29b-41d4-a716-446655440001/measurements?start_date=2024-01-01&end_date=2024-01-31" \ -H "Authorization: Bearer YOUR_API_KEY"Analysen
Endpunkte für Analysen und Trophie-Index
Gibt Analysen und Trophie-Index für ein Gewässer zurück
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
id | uuid | path | required | Die eindeutige ID des Gewässers |
Beispiele
curl -X GET "https://api.natureware.de/api/v1/waterbodies/550e8400-e29b-41d4-a716-446655440001/analytics" \ -H "Authorization: Bearer YOUR_API_KEY"Gibt Trend-Indikatoren für ein Gewässer zurück
Parameter
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
id | uuid | path | required | Die eindeutige ID des Gewässers |
parameter | string | query | optional | Filtert nach einem bestimmten Parameter |
Beispiele
curl -X GET "https://api.natureware.de/api/v1/waterbodies/550e8400-e29b-41d4-a716-446655440001/trends" \ -H "Authorization: Bearer YOUR_API_KEY"Sponsoren
Endpunkte für Sponsoren-Daten
Gibt eine Liste aller Sponsoren zurück
Beispiele
curl -X GET "https://api.natureware.de/api/v1/sponsors" \ -H "Authorization: Bearer YOUR_API_KEY"