Desarrollador

 

Guía de la API de Acortador de Enlaces URLs.

 

Este tutorial le mostrará cómo utilizar la nueva API de "Acortador de Enlaces URLx", versión Premium. 

 

Registrarse para una clave API


Se requiere una clave API para que el sistema pueda procesar las solicitudes. Una vez que un usuario se registra, se genera automáticamente una clave API para este usuario.

La clave API debe adjuntarse para solicitar a través del parámetro API (ver el ejemplo completo a continuación).

 

Enviar una solicitud para acortar una URL

 

Para enviar una solicitud, el usuario debe usar el siguiente formato donde se requieren las variables API y URL. En el siguiente ejemplo, se usa la URL de la demostración, pero debe usar su propio nombre de dominio. Para solicitar un alias personalizado, simplemente agregue &custom=CUSTOMALIAS al final.

Ejemplo: GET http://yourwebsite.com/api?key=APIKEY&url=URLLARGAARECORTAR&custom=CUSTOMALIAS

 

Respuesta del servidor


La respuesta se codificará en formato JSON (predeterminado). Esto se hace para facilitar el uso de idiomas cruzados. El primer elemento de la respuesta siempre indicará si se ha producido un error (error: 1) o no (error: 0). El segundo elemento cambiará con respecto al primer elemento. Si hay un error, el segundo elemento se llamará "msg". que contiene la fuente de error, de lo contrario se llamará "short" que contiene la URL corta. (Vea abajo para un ejemplo)

 
// No errors
{
  "error":0,
  "short":"http:\/\/yoursite.com\/DkZOb"
  }
  // An error has occurred
  {
  "error":1,
  "msg":"Please enter a valid URL"
 

}

 

Utilizar el formato de Texto Plano


Ahora puede solicitar que la respuesta sea en texto plano simplemente agregando &format=text al final de su solicitud. Esto devolverá solo http://urlx.xyz/short/DkZOb en lugar de la respuesta JSON. Tenga en cuenta que si ocurre un error, no generará nada.

 

Usando la API en PHP


Para usar la API en su aplicación PHP, debe enviar una solicitud GET a través de file_get_contents o cURL: ambos son métodos confiables. Puede ver un código de ejemplo a continuación usando file_get_contents.

 
 

// Using JSON Response

  $api_url="http://yoursite.com/api?key=APIKEY&url=URLLARGAARECORTAR&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://yoursite.com/api?api=APIKEY&url=URLLARGAARECORTAR&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
  echo $res;
  }
  ?>