MFI API Dokumentation
Entwicklerdokumentation der Mähbarkeitsindex (MFI) API. Alle Informationen zur Authentifizierung, zu verfügbaren Endpoints, Eingabeparametern und zur Antwortstruktur – strukturiert nach Themen.
API auf einen Blick
Die MFI API ist eine REST-orientierte HTTP-Schnittstelle. Wetterdaten werden vom Client per POST übertragen, der Mähbarkeitsindex (MFI) führt alle notwendigen Berechnungen durch und die Antwort erfolgt im JSON-Format.
Base URL
https://api.maehbarkeitsindex.de
Antwortformat
application/json; charset=utf-8
Authentifizierung
API-Key (Bearer Token)
CORS
Access-Control-Allow-Origin: *
Jede Antwort folgt einem einheitlichen Aufbau mit den drei Feldern status, mfi und message:
{
"status": " ... ", // Verarbeitungsstatus: ok | error
"mfi": { ... }, // Berechnungsergebnis oder null bei Fehler
"message": "..." // Fehlermeldung oder leer bei Erfolg
}
In vier Schritten zur ersten Antwort
1. Zugang anfordern
API-Zugang über das Registrierungsformular beantragen. Nach manueller Prüfung wird ein persönlicher API-Key bereitgestellt.
Jetzt registrieren →2. Authentifizieren
Den API-Key als Bearer Token im Authorization-Header oder als Parameter api_key übermitteln.
3. Daten senden
Wetterdaten per POST an den aktuellen Calculate-Endpoint übermitteln. Mindestanforderungen beachten!
4. Ergebnis lesen
Die API antwortet mit allen Angaben des Mähbarkeitsindex (z.B. Gesamt-Status, Gesamt-Indexwert, Check-Ergebnisse etc...) und Meta-Informationen zum Verarbeitungsprozess des MFI.
5. Quellenangabe einbinden
Wenn du Ergebnisse des Mähbarkeitsindex (MFI) auf deiner Website, in einer Anwendung oder in einem anderen Medium veröffentlichst, solltest du eine gut sichtbare Quellenangabe integrieren. Je nach Darstellung der Daten kann dies beispielsweise als Textlink oder als offizielles Badge erfolgen.
Beispiel für einen Quellenlink:
Mähbarkeitsindex bereitgestellt von
Mähbarkeitsindex.de
Beispiel-Linktext: „Mähbarkeitsindex (MFI) von Maehbarkeitsindex.de“
Werden die Ergebnisse grafisch dargestellt, empfiehlt sich die Verwendung eines offiziellen MFI-Badges. Informationen zu verfügbaren Badges, Platzierungsempfehlungen und Designvorgaben findest du im MFI-Styleguide .
Alle Dokumentationsseiten
Die Dokumentation ist in mehrere thematische Bereiche aufgeteilt. Jede Seite behandelt einen Aspekt der API-Integration.
Implementierungstipps
Wartungsmodus behandeln, Mähsaison berücksichtigen und MFI Ergebnisse optimal darstellen.
/api/tipps
Zur Seite →
Authentifizierung
API-Key beantragen, Bearer Token verwenden, Übertragungsmethoden und Sicherheitshinweise.
/api/authentifizierung
Zur Seite →
Endpoint /calculate
Alle Eingabeparameter, Pflichtfelder, optionale Felder, Request-Beispiele und vollständige Antwortstruktur.
/api/endpoint-calculate
Zur Seite →
Endpoint /health
Systemstatus der API prüfen. Datenbankzustand, Wartungsmodus und Konfigurationsstatus abfragen.
/api/endpoint-health
Zur Seite →
Regeln & Rate Limits
Rate-Limiting-Verhalten, API-Key-Regeln, IP-Blacklist und vollständige Tabelle aller HTTP-Fehlercodes.
/api/regeln
Zur Seite →
API Changelog
Versionshistorie der MFI API mit neuen Funktionen, Änderungen an Endpunkten, Fehlerbehebungen und Breaking Changes.
/api/changelog
Zur Seite →
MFI API Tester
Teste die MFI API direkt im Browser. Sende eigene Anfragen, prüfe Response-Daten und experimentiere mit verschiedenen Eingabeparametern.
/api/mfi-api-tester
Zur Seite →
API FAQ & Begriffe
Erklärungen zu API-Datenfeldern, Statuswerten, Indexwerten, Checks, Scores und weiteren Begriffen der MFI API.
/api/faq
Zur Seite →
Verfügbare Endpoints
Die MFI API stellt aktuell zwei Endpoints bereit.
| Endpoint | Methode | Auth | Beschreibung |
|---|---|---|---|
| /v1/calculate | POST | Pflicht | MFI aus Wetterdaten berechnen |
| /health | GET | Keiner | API-Systemstatus prüfen |
Fragen, Probleme oder Feedback?
Bei Fragen zur API, technischen Problemen, gefundenen Fehlern oder Verbesserungsvorschlägen – einfach Kontakt aufnehmen.
Kontakt aufnehmen →