Entwickler / Developer

Registrierung für einen API Key

Es ist ein API-Schlüssel für Anfragen erforderlich, die vom System verarbeitet werden sollen. Sobald sich ein Benutzer registriert, wird automatisch ein API-Schlüssel für diesen Benutzer generiert. Der API-Schlüssel muss über den Parameter api angefordert werden (siehe vollständiges Beispiel unten).
Senden einer Anforderung zur Verkürzung einer URL

Um eine Anfrage zu senden, muss der Benutzer das folgende Format verwenden, in dem die Variablen api und url erforderlich sind. Im folgenden Beispiel wird die URL der Demo verwendet, aber du solltest deinen eigenen Domainnamen verwenden. Um einen benutzerdefinierten Alias ​​anzufordern, füge einfach &custom = am Ende hinzu.

  GET
https://short.micserver.de/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS

 



Serverantwort

Wie zuvor wird die Antwort im JSON-Format codiert (Standard). Dies wird getan, um den sprachübergreifenden Gebrauch zu erleichtern. Das erste Element der Antwort wird immer sagen, ob ein Fehler aufgetreten ist (error:1) oder nicht (error:0). Das zweite Element ändert sich in Bezug auf das erste Element. Wenn es einen Fehler gibt, wird das zweite Element mit dem Namen "msg" bezeichnet. Die sie Fehlerquelle enthält, sonst wird sie "short" genannt, die die kurze URL enthält. (siehe unten für ein Beispiel)

// keine Fehler / no errors
{
  "error":0,
  "short":"https:\/\/short.micserver.de/\/
CD7nz"
}
// Ein Fehler ist entstanden / An error has occurred
{
  "error":1,
  "msg":"Bitte gültige Email eingeben"
}

 


Mit Klartextformat verwenden

Sie können nun die Antwort in Klartext anfordern, indem Sie einfach &format = Text am Ende Ihrer Anfrage hinzufügen. Dies wird nur den Link > https://micserver.de/short/
CD7nz anstatt der JSON-Antwort zurückgeben. Beachten Sie, dass, wenn ein Fehler auftritt, wird es nichts ausgeben.

 


Verwenden der API in PHP:

Um die API in deiner PHP-Anwendung zu verwenden, musst du eine GET-Anfrage über file_get_contents oder cURL senden: Beide sind zuverlässige Methoden. Sie können einen Beispielcode unten mit file_get_contents sehen.

  // JSON Response verwenden / Using JSON Response
  $api_url="https://short.micserver.de/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"];
  }

 

  // Verwenden von Plain Text Response / Using Plain Text Response
  $api_url="https://short.micserver.de/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
    echo $res;
  }
?>