#Documentation of the Voizle.com REST API methods

Introduction

The voizle.com API allows developers to interact in a programmatic way with the voizle.com website.

REST API

Shorten Url Usage

Your all request should be made to http://api.voizle.com/?PARAMETERS using GET or POST method along with PARAMETERS as Follows: ---

Required Parameter

u=URL

Replace URL with your Long URL, which you want to short.

OR

id = ID

Provide unique id to identify shorten voizle URL with your long URL. (if id is not unique then it will select any random id).

Optional Parameter

crawl = (NO)	Making crawl to NO, will respond faster. Else VoizleBot will crawl to mentioned URL and then respond. (Recommended: NO).
type = (SHORT | ALL)	Type must be SHORT or ALL, SHORT will provide you only LongURL, ShortUrl, and ID. And ALL provides you every details for required URL. (Note: for SHORT make crawl parameter to NO).
format = (JSON)	you can have your return format in JSON or XML.
property = PROPERTY-NAME	You can get any of the single information in Plain Format.

Return Format

   <voizle>
     <title> Return page title (Not when type=SHORT) </title>
     <description> Return page description (Not when type=SHORT) </description>
     <tags> Return page keywords (Not when type=SHORT) </tags>
     <originalurl> Return Long URL </originalurl>
     <voizleurl> Return Short URL </voizleurl>
     <urlid> Return URLID </urlid>
     <clicks> Return page Visits (Not when type=SHORT) </clicks>
     <refs> Return page Referers (Not when type=SHORT) </refs>
     <success> Return true when Long URL is valid URL </success>
   </voizle>

Examples

JSON Format

• http://api.voizle.com/?format=json&crawl=no&type=short&u=http://www.crazyfriendz.com

{"voizle" : {"originalurl" : "http://www.crazyfriendz.com",
 "voizleurl" : "http://u.voizle.com/swkvm", "urlid" : "swkvm", "success" : "true"}}

• http://api.voizle.com/?format=json&type=all&u=http://www.crazyfriendz.com

{"voizle" : {"title" : "Crazy Friendz - Social Networking - Login - CrazyFriends, Encyclopedia, QuestionAnswer, Download, FileSharing, CrazyLyrics", 
"description" : "Join crazyfriendz and grab all crazy friends , school, college friends, office friends, collected them all and touch with them.", 
"tags" : "Low bandwidth, create free Blog, Hidden message, Share photos with friends, Privacy setting, Notifications, 
Poker game Fun zone, point system, watcher, bulletin, file sharing, crazy search provider", 
"originalurl" : "http://www.crazyfriendz.com", "voizleurl" : "http://u.voizle.com/swkvm", 
"urlid" : "swkvm", "clicks" : "23", "refs" : "2", "success" : "true"}}

XML Format

• http://api.voizle.com/?crawl=no&type=short&u=http://www.crazyfriendz.com

   <voizle>
     <originalurl>http://www.crazyfriendz.com</originalurl>
     <voizleurl>http://u.voizle.com/swkvm</voizleurl>
     <urlid>swkvm</urlid>
   </voizle>

• http://api.voizle.com/?type=all&u=http://www.crazyfriendz.com

   <voizle>
     <title>Crazy Friendz - Social Networking</title>
     <description>Join crazyfriendz and grab all</description>
     <tags>Low bandwidth, create free Blog, Hidden message, Share photos with friends</tags>
     <originalurl>http://www.crazyfriendz.com</originalurl>
     <voizleurl>http://u.voizle.com/swkvm</voizleurl>
     <urlid>swkvm</urlid>
     <clicks>23</clicks>
     <refs>2</refs>
   </voizle>

Plain Format (only with property parameter)

• http://api.voizle.com/?crawl=no&type=all&property=voizleurl&u=http://www.crazyfriendz.com

  http://u.voizle.com/swkvm

• http://api.voizle.com/?type=all&property=title&u=http://www.crazyfriendz.com

  Crazy Friendz - Social Networking

(Note: To get detail of shorten URL or to Expand Voizle Url, Remove "u" Parameter from REST)

Expand Short Url Usage

For Expand short url, request should be made to http://api.voizle.com/expand?PARAMETERS using GET or POST method along with PARAMETERS as Follows:

u=URL

Replace URL with your Long URL, which you want to short.

Optional Parameter

format = (JSON)

you can have your return format in JSON or otherwise default is XML.

Return Format

   <vexpand>
     <shorturl> Return same url which comes with request </shorturl>
     <longurl> Return long url if found error return same short url </longurl>
   </vexpand>

Examples

JSON Format

• http://api.voizle.com/expand?format=json&u=http://u.voizle.com/crazy

{"vexpand" : {"shorturl" : "http://u.voizle.com/crazy",
 "longurl" : "http://www.crazyfriendz.com"}}

XML Format

• http://api.voizle.com/expand?u=http://u.voizle.com/crazy

   <vexpand>
     <shorturl>http://u.voizle.com/crazy</shorturl>
     <longurl>http://www.crazyfriendz.com</longurl>
   </vexpand>