Hallo Tankerkönig-API-User und Modulentwickler
Bei der Verwendung der API, insbesondere bei Entwicklung eines Spritpreis-Moduls sollten einige Punkte beachtet werden:
Prüfen der Antwort
Niemals darauf vertrauen dass die API das gewünschte liefert. Das gilt übrigens für jede (Web-)API.
Also immer testen ob evtl. ein Fehler zurückkommt.
Es gibt immer wieder Probleme, weil manche Modul-Entwickler für die diversen HA-Systeme auf diese Checks verzichten.
HTTP-Code
Statt dem 200-Code, der einem OK-Status entspricht können auch 403, oder 503 geliefert werden.
-> Das sollte nicht ignoriert werden.
Fehlermeldung im JSON-Response
Auch mit dem 200 - Response ist noch nicht klar, ob der Request tatsächlich erfolgreich war:
Statt der erwarteten Tankstellen-/Spritpreis-Infos kann eine Fehlermeldung kommen, bspw:
{
"ok": false,
"message": "apikey nicht angegeben, falsch, oder im falschen Format"
}
-> immer das ok-Flag testen. Wenn das nicht true ist gibt es ein Problem.
Das wird nicht besser, wenn man weitere 1000 mal den Request absetzt.
-> die Fehlermeldung sollte irgendwo angezeigt werden, damit klar ist daß
was nicht richtig ist und damit das Problem gelöst werden kann.
Inhaltliche Fehler
Preise falsch? Offen-Status falsch? Öffnungszeiten stimmen nicht? sonstige Fehler?
-> lasst es uns wissen. Ohne Hinweise von euch können wir das nicht lösen.
Fehler-/Problemmeldungen
Mail an info@tankerkoenig.de
Gruß,
Tankerkönig
