API

Für einen API Key registrieren

Ein API Key wird benötigt um Anfragen an das System zu bearbeiten. Nach dem sich der User registriert hat, ist der API Key automatisch generiert. Der API Key muss dem "Request" angefügt werden. (Beispiel weiter unten)

Senden einer Anforderung zum Verkürzen einer URL

Um eine Anfrage zu senden, muss der Benutzer das folgende Format verwenden, wobei die Variabeln API & URL erforderlich sind. Um einen benutzerdefinierten ALIAS zu verwenden einfach &custom= am Ende hinzufügen

  GET https://shrt.li/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS

Server Antwort

Die Antwort wird in JSON ausgegeben. Dies geschieht um die "sprach übergreifende" Nutzung zu erleichtern. Das erste Element der Antwort wird immer sagen ob ein Fehler aufgetreten ist oder nicht. Ist ein Fehler aufgetreten wird das zweite Element in msg geändert, dies enthält die Fehlerquelle.

// No errors
{
  "error":0,
  "short":"https:\/\/shrt.li\/DkZOb"
}
// An error has occurred
{
  "error":1,
  "msg":"Please enter a valid email"
}

Textformat verwenden

Sie können die Antwort in normalem Text anforden durch hinzufügen von &format=text am Ende. Dann kommt einfach https://crypturl.me/DkZOb anstatt der JSON Antwort. Bitte beachte, wenn Fehler auftreten wird nichts ausgegeben.

Verwendung der API in PHP

Um die API in PHP zu verwenden, muss man eine GET request mit file_get_contents or cURL senden: Beide sind zuverlässige Methoden. Ein Beispiel für file_get_contents gibt es unten.
 // Using JSON Response
  $api_url="https://shrt.li/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS";
  $res= @json_decode(file_get_contents($api_url),TRUE);
  if($res["error"]){
    echo $res["msg"];
  }else{
    echo $res["short"];
  }

 // Using Plain Text Response
  $api_url="https://shrt.li/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";

  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }
?>