MFI API Implementierungstipps
Praktische Hinweise und Empfehlungen für die Integration der MFI API in eigene Anwendungen, Websites oder Systeme. Von der Behandlung des Wartungsmodus über den optimalen Nutzungszeitraum bis zur Darstellung der Ergebnisse.
Tipps für eine gelungene MFI Integration
Die MFI API liefert Indexwerte, Statusmeldungen und Prüfergebnisse, die in unterschiedlichste Anwendungen integriert werden können. Die folgenden Tipps helfen dabei, typische Integrationsfragen vorab zu klären und die Darstellung des MFI für die eigenen Nutzer optimal zu gestalten.
Wartungsmodus berücksichtigen
Die MFI API kann sich temporär im Wartungsmodus befinden. In diesem Fall antwortet die API mit dem HTTP-Statuscode 503 und dem Status error sowie der Meldung „The API is currently undergoing maintenance."
Der aktuelle Wartungsstatus kann jederzeit über den /health Endpunkt geprüft werden. Dieser liefert im Feld maintenance_mode den Wert true oder false.
Für eine robuste Integration empfiehlt es sich, den Wartungsmodus in der eigenen Anwendung abzufangen. Mögliche Strategien sind:
Hinweismeldung anzeigen
Anstelle der MFI Darstellung wird ein Hinweis eingeblendet, dass der Mähbarkeitsindex vorübergehend nicht verfügbar ist. So wissen die Nutzer, dass keine aktuelle Bewertung vorliegt, ohne dass die Anwendung fehlerhaft wirkt.
Letzten MFI mit Zeitstempel anzeigen
Die letzte erfolgreich abgerufene Berechnung wird weiterhin angezeigt, ergänzt um einen Zeitstempel der letzten Aktualisierung. So bleibt für die Nutzer erkennbar, dass es sich nicht um eine aktuelle Bewertung handelt, die letzte bekannte Einschätzung aber weiterhin sichtbar ist.
Empfehlung: Wartungsarbeiten dauern in der Regel nur wenige Minuten und treten selten auf. Eine Kombination beider Strategien – letzter MFI mit Zeitstempel und ergänzendem Hinweis – bietet den Nutzern die beste Transparenz.
Optimaler Nutzungszeitraum
Der MFI liefert ganzjährig Bewertungen – auch in den Wintermonaten. Für die Integration in eigene Anwendungen empfiehlt es sich jedoch, die Anzeige des MFI auf den Zeitraum der Mähsaison zu beschränken: vom 1. März bis Ende Oktober.
In den Wintermonaten liefert der MFI zwar Berechnungen, die Ergebnisse sind jedoch in den meisten Fällen sinnvollerweise BLOCK, da die Witterungsbedingungen einen Rasenschnitt in der Regel nicht zulassen. Die typische Mähsaison in Mitteleuropa erstreckt sich von März bis Oktober.
MFI saisonal ein- und ausblenden
Außerhalb der Mähsaison kann die MFI Darstellung ausgeblendet oder durch einen Hinweis ersetzt werden, dass die Mähsaison aktuell pausiert. API-Anfragen können in diesem Zeitraum reduziert oder eingestellt werden.
Ganzjährige Anzeige mit Kontext
Alternativ kann der MFI ganzjährig angezeigt werden, wenn die Darstellung um einen Hinweis auf die aktuelle Jahreszeit ergänzt wird. So ist für die Nutzer erkennbar, warum der MFI außerhalb der Saison dauerhaft niedrige Werte oder den Status BLOCK anzeigt.
Hinweis: Auch innerhalb der Mähsaison kann es vereinzelt zu BLOCK-Bewertungen kommen – etwa bei anhaltendem Starkregen, Frost im Frühjahr oder extremen Temperaturen. Diese Bewertungen sind fachlich korrekt und sollten dem Nutzer wie gewohnt angezeigt werden.
Darstellung des MFI
Die MFI API liefert sowohl den Gesamt-Indexwert als auch den Gesamt-Status sowie detaillierte Prüfergebnisse der einzelnen Checks. Wie diese Daten den Nutzern präsentiert werden, hängt vom Einsatzzweck und der gewünschten Informationstiefe ab.
Am besten orientiert man sich bei der Darstellung an den vorhandenen Praxisbeispielen, die unterschiedliche Detailstufen zeigen.
Ampelsystem
Die einfachste Darstellung nutzt das Ampelprinzip: Grün (OK), Gelb (WARNING) und Rot (BLOCK). Der Gesamt-Status wird als farbiger Indikator angezeigt – ideal für kompakte Widgets, Dashboards oder Kurzübersichten, bei denen eine schnelle Einschätzung im Vordergrund steht.
Ampelsystem mit Check-Darstellung
Ergänzend zum Gesamtstatus können die einzelnen Check-Ergebnisse (Temperatur, Niederschlag, Luftfeuchtigkeit, Bodentemperatur, Wind) dargestellt werden. Jeder Check hat einen eigenen Check-Status und Check-Indexwert, sodass Nutzer auf einen Blick erkennen, welcher Faktor den Rasenschnitt aktuell beeinflusst.
Detaildarstellung mit Check-Begründungen
Die umfangreichste Variante zeigt zusätzlich die Check-Begründungen an, die erklären, warum ein bestimmter Check den jeweiligen Status erhalten hat. Diese Darstellung eignet sich für Anwendungen, die ihren Nutzern ein möglichst transparentes und nachvollziehbares Ergebnis bieten möchten.
Alle Dokumentationsseiten
Die Dokumentation ist in mehrere thematische Bereiche aufgeteilt. Jede Seite behandelt einen Aspekt der API-Integration.
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 →