General API¶

Wetterwarnungen¶

Wetterwarnungen für bestimmte Zonen nach dem deutschen Wetterdienst ermitteln

Endpoint¶

/wetterwarnungen?zones={weoid1[,weoid1,...]}

Response¶

{
    "status": 200,
    "messages": [],
    "data": {
        "warnings": [
            {
                "regionName": "{Name der Stadt|Region|Kreis}}",
                "start": "{Y-m-d H:i:s}",
                "end": "{Y-m-d H:i:s}",
                "level": "{Level als Zahl}",
                "type": "{Typ als Zahl}",
                "state": "{Bundesland}}",
                "description": "{Beschreibung}}",
                "event": "{Wettercode als Text}}",
                "headline": "{Titel der Wetterwarnung}",
                "instruction": "",
                "stateShort": "{Abkuerzung Bundesland}"
            }
        ],
        "credits": "Copyright Deutscher Wetterdienst modified by Timo Reymann"
    }
}

UUID-Generator¶

UUIDs in verschiedenen Generationen erzeugen

Endpoint¶

/uuid[?version={1,3,4,5}}][&domain={my.tld}}]

Response¶

{
    "status": 200,
    "messages": [],
    "data": {
        "uuid": "{UUID}",
        "version": "{Version als Integer}"
    }
}

Mail¶

E-Mail verschicken (nur mit Token möglich)

Endpoint¶

/mail

Request¶

{
    "message": "{Mail body as plain text}}",
    "token": "{Token}",
    "recieverName": "{Reciever display name}",
    "recieverMail": "{Reciever email}",
    "subject": "{Subject for mail}"
}

Response¶

{
    "status": 200,
    "messages": [],
    "data": [
        "Mail sent"
    ]
}

Minecraft Serverstatus¶

Minecraft Serverstatus

Endpoint¶

/mcstatus?address={Server address as domain or ip address}

Response¶

{
    "status": 200,
    "messages": [],
    "data": {
        "version": "{Serversoftware name} {Serversoftware minecraft version}",
        "protocol": "{protocol revision}",
        "max": "{Max players}",
        "online": "{ Online players }",
        "favicon": "data:image\/png;base64,{BASE64 representation of server icon}",
        "motd": "{Message of the day}",
        "modInfo": "{Info about mod compatibility|null}",
        "mods": "{List of mods|null}"
    }
}

RDP-Dateien erstellen¶

Dateien für schnelle RDP-Verbindung

Endpoint¶

/rdp?address={Server address as domain or ip address}&username={Username for rdp user}

Response¶

File als application/ocet-stream

WOEID zu einem Ort¶

Diese API soll das finden von Woeids erleichtern. Eine WOEID ist eine global eindeutige Nummer für die Identifzierung eines Punktes auf der Erde. Sie wird unter anderem für Wetterdaten benutzt. Unter anderem auch für die Ermittlung der Wetterwarnungen vom DWD.

Endpoint¶

/geo?name={Name des Ortes}

Response¶

[
  {
    "postal": "{zip code}",
    "name": "{name of place}",
    "country": "{country}",
    "state": "{state}",
    "woeId": "{woeid}",
    "district": "{district}"
  }
]

Wetterwarnungen¶

Wetterwarnungen für bestimtme Zonen nach dem deutschen Wetterdienst ermitteln

Endpoint¶

/wetterwarnungen?zones={weoid1[,weoid1,...]}

Response¶

{
    "status": 200,
    "messages": [],
    "data": {
        "warnings": [
            {
                "regionName": "{Name der Stadt|Region|Kreis}}",
                "start": "{Y-m-d H:i:s}",
                "end": "{Y-m-d H:i:s}",
                "level": "{Level als Zahl}",
                "type": "{Typ als Zahl}",
                "state": "{Bundesland}}",
                "description": "{Beschreibung}}",
                "event": "{Wettercode als Text}}",
                "headline": "{Titel der Wetterwarnung}",
                "instruction": "",
                "stateShort": "{Abkuerzung Bundesland}"
            }
        ],
        "credits": "Copyright Deutscher Wetterdienst modified by Timo Reymann"
    }
}

QR-Code generieren¶

Diese API soll es vereinfachen Anwendungen mit QR-Code-Funktionalität zu versehen. Hierbei übernimmt die API die Erstellung einer Grafik für den Entwickler. Der Inhalt kann frei belegt werden. Hierbei kann natürlich auch auf die Standardprotokolle zurückgegriffen werden. Die Größe passt sich hierbei automatisch an die Menge der Daten an

Endpoint¶

/qrcode?content={Klartext für den QR-Code}&contentType={gif,svg}

Response¶

Eine SVG oder GIF je nach Anfrage.

HTML in PDF rendern¶

Diese API soll es vereinfachen Anwendungen PDF-Dateien aus einem HTML-Input generien. Dieser kann hierbei auch CSS beinhalten. Animationen usw. werden natürlich nicht nativ durch PDFs unterstützt.

Endpoint¶

/html2pdf?pageSize={A4,...}&fileName={output.pdf, ...}&languageCode={de, ...}&charset={UTF-8, ...}&margin={10, ...}&forceDownload={false|true}

Request¶

Die entsprechenden Parameter in den URLs sind Standardwerte und müssen nicht übergeben werden. Der Body hingegen ist zwingend erforderlich.

{
    "html": "<h1>Hello World</h1>"
}

Response¶

Error¶

{
    "status": 400,
    "messages": [
        "Required html body is missing"
    ],
    "data": []
}

Success¶

PDF entsprechend mit Downoad-Force oder ohne.