API

Last Updated November 26, 2021

This tutorial will show you how to use the new API of Webz.cc. There were some changes to the API in order facilitate requests from developers.

Registering for an API Key

As before, an API key is required for requests to be processed by the system. Upon registration, an API key is automatically generated for this user. The API key must attached to request via the api parameter (see full example below).

Sending a request for shortening a URL

To send a request, the user must use the following format where the variables api and url are required. In the example below, the URL of the demo is used but you should use your own domain name. To request a custom alias, simply add &custom= at the end.

  GET http://webz.cc/api?key=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS
view rawrequest.txt hosted with ❤ by GitHub

Server response

As before, the response will encoded in JSON format (default). This is done to facilitate cross-language usage. The first element of the response will always tell if an error has occurred (error: 1) or not (error: 0). The second element will change with respect to the first element. If there is an error, the second element will be named “msg”. which contains the source of error, otherwise it will be named “short” which contains the short URL. (See below for an example)

  // No errors
  {
  "error":0,
  "short":"http:\/\/webz.cc\/DkZOb"
  }
  // An error has occurred
  {
  "error":1,
  "msg":"Please enter a valid URL"
  }
view rawresponse.json hosted with ❤ by GitHub

USING PLAIN TEXT FORMAT

You can now request the response to be in plain text by just adding &format=text at the end of your request. This will return just https://webz.cc/DkZOb instead of the JSON response. Note that if an error occurs, it will not output anything.

Using the API in PHP

To use the API in your PHP application, you have to send a GET request through file_get_contents or cURL: Both are reliable methods. You can see a sample code below using file_get_contents.

 
  // Using JSON Response
  $api_url="http://webz.cc/api?key=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://webz.cc/api?api=APIKEY&url=THELONGURLTOBESHORTENED&custom=CUSTOMALIAS&format=text";
  $res= @file_get_contents($api_url);
  if($res){
  echo $res;
  }
  ?>
view rawapi.php.php hosted with ❤ by GitHub

Sample Function

 
   
  define("SHORTENER_URL", "http://webz.cc");
  define("SHORTENER_KEY", "123456789");
   
  /**** Sample PHP Function ***/
  function shorten($url, $custom = "", $format = "json") {
  $api_url = SHORTENER_KEY."/api/?key=".SHORTENER_KEY;
  $api_url .= "&url=".urlencode(filter_var($url, FILTER_SANITIZE_URL));
  if(!empty($custom)){
  $api_url .= "&custom=".strip_tags($custom);
  }
  $curl = curl_init();
  curl_setopt_array($curl, array(
  CURLOPT_RETURNTRANSFER => 1,
  CURLOPT_URL => $api_url
  ));
  $Response = curl_exec($curl);
  curl_close($curl);
   
  if($format == "text"){
  $Ar = json_decode($Response,TRUE);
  if($Ar["error"]){
  return $Ar["msg"];
  }else{
  return $Ar["short"];
  }
  }else{
  return $Response;
  }
  }
  ?>
view rawShortener.API.Function.php hosted with ❤ by GitHub