Übersicht

xlURL's | Klicks 20.747 | 905.605
generiert vor 6 Minuten

Partner + Linktipps


Anzeige


Suche nach xlURL's


API - Schnittstelle

Der einfachste Weg zu unserem Service!

xlURL.de besitzt auch eine einfach zu handhabende Schnittstelle (API), die für Programmierer optimal geeignet ist! Die API basiert auf einem sogenannter Plain-text Request.

Das Programm/Script sendet eine Standard HTTP-GET-Anfrage mit der langen URL zu unsere API. Als Antwort wird entweder die verkürzte URL oder eine Fehlermeldung zurückgegeben.
Die Ursprungs URL sollte nach HTTP-Standard kodiert sein (UrlEncode)!

Beispiel - Einfache GET-Anfrage für "http://www.google.de/":

http://xlurl.de/api?url=http%3A%2F%2Fwww.google.de%2F

Als Response gibt der xlURL Server die gekürzte URL zurück:

http://xlurl.de/4tV2s4

Wenn der zurückgegebene Wert nicht mit "http" beginnt, wurde ein Fehler zurückgegeben.
Es ist ein Fehlercode (Zahl) gefolgt von einem Semikolon und dann die Fehlermeldung.

Alle Linkparameter im Überblick:

ACHTUNG - Es gibt eine spezielle Test-API!
Wie diese zu benutzen ist schau bitte weiter unten auf der Seite! Danke!

Parameter Beschreibung
url Pflicht - Die zu kürzende URL (original URL).
Der Parameter ist nicht optional und muss angegeben werden! Die URL muss URL encodiert sein:
"http://xlurl.de/" => "http%3A%2F%2Fxlurl.de%2F"
shortto Optional - 6 bis 50 Zeichen - Der xlURL-Key.
Hier kann ein gewünschtes Kürzel angegeben werden!
(6 bis 50 Zeichen, nur a-z, A-Z, 0-9, -, _ und case sensitiv)

Beispiele:
  • meinehomepage
  • cooleseite
  • meineautosuche
  • superbuecher
  • gutscheine
appna Optional - 250 Zeichen - Applikction Name.
Hier darf der Programmierer den Namen seines Programms/Webseite angeben! Auch ein Link darf eingebaut vorkommen.
Ganz wichtig ist auch hier die URL encodierung.

Beispiele:
  • twitter
  • Mein%20super%20Service
  • Webdienst%20auf%20http%3A%2F%2Fxlurl.de%2F
userkey Optional - 15 Zeichen - Dein API-Key.
Auch alle Links die über die API generiert werden, können
einem Account zugewiesen werden! Deinen API-Key findest
Du in deinen Profildaten.
private Optional - boolesche Wert (true|false). Standart "false"!
Hier kannst du angeben ob deine Links als Privat gespeichert
werden sollen. Sie werden dann in allen öffentlichen Statistiken
und Auflistungen nicht angezeigt.
ACHTUNG! true und false bitte klein schreiben!
 

Ein Beispiel für PHP:

<?php
$originalurl = "http://www.google.de/";
$request = "http://xlurl.de/api?url=".urlencode($originalurl);
$response = file_get_contents($request);
if (substr($response, 0, 4) == "http") {
echo "verk&uuml;rzte URL: $response";
} else {
list ($error_code, $error_message) = explode(";", $response);
echo "Fehler: $error_message ($error_code)";
}
?>

Ein Beispiel für ASP/VB.NET:

<%
Dim wc As New WebClient
Dim originalurl As String = "http://www.google.de/"
Dim request As String = "http://xlurl.de/api?url=" & Server.UrlEncode(originalurl)
Dim responseDatabuffer As Byte() = wc.DownloadData(request)
Dim response As String = Encoding.ASCII.GetString(responseDatabuffer)
If request.Substring(1,4) = "http" Then
Response.Write("verk&uuml;rzte URL: " & response)
Else
Response.Write("Fehler: " & response.Split(";")(1))
End If
%>



Testen - Wichtig, wenn Du die API testen möchtest

Ich habe für testzwecken eine extra API eingerichtet
Die Grund-URL lautet dann:

http://xlurl.de/apitest?url=...

Der Rest ist sonst wie oben beschrieben!
Als positiven Response gibt der xlURL Server immer diese xlURL zurück:

http://xlurl.de/apitest_OK



API im "Rückwärtsgang" - "Take me back"

Es gibt bei xlURL.de ebenso eine Rückwärtsauflösung der Adresse mit Hilfe der API!
Auch hier ist es eine einfache HTTP-GET-Anfrage, die die Ursprungs URL zurückgibt.

Die Übergabeparameter müssen, genauso wie oben, nach HTTP-Standard kodiert sein (UrlEncode).
Als Übergabewert kann entweder die gesamte xlURL oder auch nur der xlURL-Key angegeben werden.

Beispiel - Einfache GET-Anfrage für "http://xlurl.de/4tV2s4":

http://xlurl.de/apiback?key=http%3A%2F%2Fxlurl.de%2F4tV2s4

Als Response gibt der xlURL Server die ursprüngliche URL zurück:

http://www.google.de/

Wenn der zurückgegebene Wert nicht mit "http" beginnt, wurde ein Fehler zurückgegeben.
Es ist ein Fehlercode (Zahl) gefolgt von einem Semikolon und dann die Fehlermeldung.

Alle Linkparameter im Überblick:

Parameter Beschreibung
key Pflicht - Die gekürzte URL bzw der xlURL-Key.
Der Parameter ist nicht optional und muss angegeben werden! Der Wert muss URL encodiert sein:
Beispiele:
  • http%3A%2F%2Fxlurl.de%2F4tV2s4 für http://xlurl.de/4tV2s4
  • http%3A%2F%2Fxlurl.de%2F4tV2s4? für http://xlurl.de/4tV2s4? (Statistiklink)
  • xlurl.de%2F4tV2s44tV2s4
  • 4tV2s4