API – Eiswarnung für deine Projekte

Unsere Daten für deine Projekte

Du bastelst dir einen Eis-Wecker aus einem Raspberry Pi, welcher dich im Ernstfall 15 Minuten früher weckt oder du möchtest einfach nur die Eisvorhersage auf deiner Homepage anzeigen? Unsere API (Programmierschnittstelle) stellt dir die benötigten Daten zur Verfügung.


 

Verfügbare Daten

Die REST-API nimmt Geokoordinaten entgegen und gibt dir die Wahrscheinlichkeit von vereisten Scheiben für den kommenden Morgen zurück. Die kostenlose API erlaubt dir täglich bis zu 50 Abfragen.


 

API-Key

Du möchtest die kostenlose API verwenden? Kein Problem, hier geht es zum Anmeldeformular:
Kostenlosen API-Key erhalten

API-Zugänge ohne Volumenbegrenzung sind auf Anfrage natürlich auch möglich z.B. für Anbieter von Smart Home-Geräten, Fahrzeugsteuerung oder Betreiber von Wetterdiensten etc.

info@eiswarnung.de


 

API-Dokumentation

Optimale Ergebnisse erzielen:

Die Berechnung der Eis-Wahrscheinlichkeit stützt sich auf Wetterdaten von openweathermap.org. Fragst du zu früh ab, ist die Vorhersage möglicherweise noch ungenau, fragst du zu spät ab, fehlen dem Algorithmus Messpunkte. Optimal sind daher 8-10 Std. vorab. Möchtest du um 8 Uhr morgens aus dem Haus, verwendest du am besten eine Vorhersage von 22-24 Uhr des Vorabends.

POST URL:

https://api.eiswarnung.de/

Request Parameter (FORM URL Encoded):

Parameter Typ Benötigt Beschreibung Beispiel
key string (32 Zeichen) ja Mit dem Key autorisierst du deine Request. 098f6bcd4621d373cade4e832627b4f6
lat float ja geographische Breite / Latitude 49.411449
lng float ja geographische Länge / Longitude 8.686380

Result Header (JSON):

Schlüssel Typ Beschreibung
success boolean War die Anfrage erfolgreich?
message string Fehler- oder Erfolgsmeldung
callsLeft int Für heute übrige Abfragen
callsDailyLimit int Tägliches Kontingent an API-Abfragen
callsResetInSeconds int Sekunden bis zum nächsten Tag und Auffrischung des Kontingents

Result Objekt (JSON):

Schlüssel Typ Beschreibung
requestDate string (YYYY-mm-dd HH:ii:ss) Zeitpunkt der Anfrage
forecastId int Vorhersage 0 = kein Eis, 1 = Eis, 2 = evtl. Eis
forecastText string Vorhersage in Worten
forecastCity string Erkannter Ort zu den Geokoordinaten
forecastDate string (YYYY-mm-dd) Tag, für welchen die Vorhersage gültig ist

Beispiel Antwort (JSON):

{
   "success":true,
   "message":"Request successful!",
   "code":200,
   "callsLeft":48,
   "callsDailyLimit":50,
   "callsResetInSeconds":24628,
   "result":{
      "requestDate":"2019-11-25 17:09:32",
      "forecastId":0,
      "forecastText":"Kein Eis.",
      "forecastCity":"Heidelberg",
      "forecastDate":"2019-11-26"
   }
}

Antwort Codes ("code"):

Statuscode Bedeutung
200 Aufruf erfolgreich
300 Geokoordinaten fehlen
400 API Key fehlt
401 API Key ungültig
402 Tägliches Call-Limit erreicht

Beispielcode PHP

$curl = curl_init();
$post = array('key' => '098f6bcd4621d373cade4e832627b4f6',
              'lat' => '49.411449',
              'lng' => '8.686380'
             );
curl_setopt($curl, CURLOPT_URL, 'https://api.eiswarnung.de/');
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $post);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HEADER, false);

$result = curl_exec($curl);
if (curl_errno($curl)) {
    $result = curl_error($curl);
}

curl_close($curl);
echo $result;

API-Test mit ReqBin

https://reqbin.com/

Du möchtest nur schnell etwas über die API testen oder Probleme bei der Implementierung debuggen? Vielleicht hilft dir dieses API-Testing-Tool weiter.