[mitchatten]

Short URL

URL

Die URL um eine Short URL zu erzeugen lautet:

https://api.relay-chat.de/2/url/create/

Ansprechen lässt sich diese URL per HTTP POST sowie per HTTP GET als JSON Callback. Wir verwenden dieses Modul um beispielsweise die Links zu dem Script der generierten Webchats zu verkürzen um ein etwas komfortableres einbinden des Links zu ermöglichen.

Parameter

Die Parameter die diesem Modul übergeben werden können sind content (die URL auf die umgeleitet werden soll) und type (kann derzeit lediglich den Wert 'redirect' annehmen).

$ curl https://api.relay-chat.de/2/url/create/?type=redirect&content=http%3A%2F%2Fwww.iZ-smart.net%2Findex.html | jsonpretty
{
  "izsmart": {
    "ajax": false,
    "cache": false,
    "cache_hash": "90a883-6580515d06b5",
    "cache_online": true,
    "mobile": false,
    "runtime": 0.15874,
    "time": 1389294845,
    "version": "tiberius/[email protected]"
  },
  "url": {
    "type": "redirect",
    "error": false,
    "status": "Die URL wurde eingetragen.",
    "shorturl": "/url/go/K2YBeD0rt9/"
  },
  "cleanup": {
    "error": false,
    "count": 0,
    "since": 1388431984
  }
}

Payload

Zugriff auf die generierte URL

Im Payload wird innerhalb des Arrays url ein Schlüssel shorturl zurückgegeben. Dieser enthält als Wert den URI zum Link selbst. Zusammengesetzt wird dieser Link aus der Basis https://api.relay-chat.de/2 sowie der URI /url/go/K2YBeD0rt9/. Der komplette Link für das aktuelle Beispiel lautet also https://api.relay-chat.de/2/url/go/K2YBeD0rt9/. Die Umleitung erfolgt mittels eines HTTP Redirect mit dem Status 302; In diesem Fall auf die komplett URL https://www.iZ-smart.net/index.html.

alte URLs

Wird eine Short URL erzeugt, dann jedoch 60 Tage lang nicht mehr genutzt wird diese automatisch vom System entfernt.