Developer

Entwicklerhandbuch

Hier werde ich erklären, wie man die neue API verwenden um Anfragen von Entwicklern zu erleichtern.

Die Registrierung für eine API-Key

Wie zuvor wird ein API-Schlüssel für die von dem System verarbeitet werden Zugriffe erforderlich. Sobald sich ein Benutzer registriert, wird ein API-Schlüssel automatisch für diesen Benutzer erzeugt. Die API-Schlüssel muss angebracht, um über die fordern  api  Parameter (siehe vollständige Beispiel unten).

Senden einer Anforderung zum Verkürzen einer URL

Um eine Anfrage zu senden, muss der Benutzer das folgende Format, wo die Variablen verwenden,  api  und  url erforderlich sind. Im folgenden Beispiel wird die URL der Demo verwendet, aber Sie sollten Ihren eigenen Domain-Namen zu verwenden. Um einen benutzerdefinierten Alias ​​beantragen, fügen Sie einfach  & custom =  am Ende.

  GET http://by3.eu/short/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS  

Server-Antwort

Nach wie vor wird die Antwort im JSON-Format (Standard) codiert. Dies geschieht, um sprachübergreifende Nutzung zu erleichtern. Das erste Element der Antwort wird immer sagen, wenn ein Fehler aufgetreten ist (Fehler: 1) oder nicht (Fehler: 0). Das zweite Element bezüglich des ersten Elements zu ändern. Wenn es einen Fehler gibt, wird das zweite Element "msg" genannt werden. die enthält die Fehlerquelle, sonst wird es "kurz" benannt werden, der die kurze URL enthält. (Siehe unten für ein Beispiel)

// No errors
{
  "error":0,
  "short":"http:\/\/by3.eu\/short\/DkZOg"
}
// An error has occurred
{
  "error":1,
  "msg":"Please enter a valid email"
}

Mit Nur-Text-Format

Sie kann nun die Antwort im Klartext sein, indem einfach  & format = Text  am Ende Ihrer Anfrage. Dies wird nur zurück  http://by3.eu/short/DkZOg  anstelle des JSON-Antwort. Beachten Sie, dass, wenn ein Fehler auftritt, wird es nichts ausgibt.

Verwendung der API in PHP

Um die API in Ihre PHP-Anwendung zu verwenden, müssen Sie eine GET-Anfrage zu senden durch  file_get_contentsoder  cURL : Beide sind zuverlässige Methoden. Sie können einen Beispielcode zu sehen mit  file_get_contents .

<? Php
  // Using JSON Response
  $api_url="http://gempixel.com/short/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="http://gempixel.com/short/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }  
?>

Estamos sociais

Facebook Likes

Curta-nos no FacebookSiga-nos no Twitter