Working with Links in Bitly

Overview

The following operations allow you to work with Links. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with links, see Sample configuration.

Operation details

This section provides further details on the operations related to link.

Returns a bitly short URL

The getLookup operation Given a long URL, returns a bitly short URL .

<bitly.getShorten>
        <longtUrlforShorten>{$ctx:longtUrlforShorten}</longtUrlforShorten>
        <bitlyShortDomain>{$ctx:bitlyShortDomain}</bitlyShortDomain>
 </bitly.getShorten>

Properties

• longUrl: A long URL to be shortened
  

• domain: (optional) The short domain to use; either bit.ly, j.mp, or bitly.com or a custom short domain
  

Sample request

Following is a sample REST/JSON request that can be handled by the getShorten operation.

{
"longUrl":"http://eclipsesource.com/blogs/2009/05/12/osgi-declarative-services/",
"domain":"nytimes.com"
}

Related Bitly documentation

http://dev.bitly.com/links.html#v3_shorten

Returns the target (long) URL .

The getExpand operation Given a bitly URL or hash (or multiple), returns the target (long) URL .

<bitly.getExpand>
    <shortUrl>{$ctx:shortUrl}</shortUrl>
</bitly.getExpand>

Properties

• shortUrl: Refers to one or more bitly links
  

Sample request

Following is a sample REST/JSON request that can be handled by the getExpand operation.

{
"shortUrl":"http://bbc.in/1ngHJH4"
}

Related Bitly documentation

http://dev.bitly.com/links.html#v3_expand

Returning the page title for a given bitly link

The getInfo operation Returns the page title for a given bitly link .

<bitly.getInfo>        
     <shortUrlforInfo>{$ctx:shortUrlforInfo}</shortUrlforInfo>
     <expandUserinfo>{$ctx:expandUserinfo}</expandUserinfo>            
</bitly.getInfo>

Properties

• shortUrlforInfo: Refers to one or more bitly links.
  

• expandUserinfo: (optional) true| false – include extra user info in response.
  

Sample request

Following is a sample REST/JSON request that can be handled by the getInfo operation.

{
"shortUrlforInfo":"http://bbc.in/1ngDL1b",
"expandUserinfo":"true"
}

Related Bitly documentation

http://dev.bitly.com/links.html#v3_info

Saving a link as a bitmark in a user's history, with optional pre-set metadata

The getLinkSave operation Saves a link as a bitmark in a user's history, with optional pre-set metadata .

<bitly.getLinkSave>
     <longtUrlforLinkSave>{$ctx:longtUrlforLinkSave}</longtUrlforLinkSave>            
     <titleforLink>{$ctx:titleforLink}</titleforLink>            
     <noteforLink>{$ctx:noteforLink}</noteforLink>             
</bitly.getLinkSave>

Properties

• longtUrlforLinkSave: String to query for.
  

• titleforLink: (optional) the title of this Bitlink.
  

• noteforLink: (optional) a description of, or note about, this Bitlink.
  

• private: (optional) boolean true or false indicating privacy setting (defaults to user-level setting).
  

Sample request

Following is a sample REST/JSON request that can be handled by the getLinkSave operation.

{
"longtUrlforLinkSave":"http://www.myfootballgames.co.uk/game/353/World-Cup-Penalty.html",
"titleforLink":"http://bit.ly/Tvs4M4",
"noteforLink":"http://bit.ly/Tvs4M4"
}

Related Bitly documentation

http://dev.bitly.com/links.html#v3_user_link_save

Searching links receiving clicks across bitly by content

The getHighvalue operation returns the “main article” from the linked page .

<bitly.getHighvalue>        
     <NoOfLinks>{$ctx:NoOfLinks}</NoOfLinks>            
</bitly.getHighvalue>

Properties

• NoOfLinks: The maximum number of high-value links to return.
  

Sample request

Following is a sample REST/JSON request that can be handled by the getHighvalue operation.

{
"NoOfLinks":"2"
}

Related Bitly documentation

Sample configuration

Following is a sample proxy service that illustrates how to connect to Bitly with the init operation and use the getLinkInfo operation. The sample request for this proxy can be found in getLinkInfo sample request.

<proxy xmlns="http://ws.apache.org/ns/synapse"
       name="bitly"
       transports="https,http"
       statistics="disable"
       trace="disable"
       startOnLoad="true">
   <target>
       <inSequence onError="faultHandlerSeq">
         <property name="accessToken" expression="json-eval($.accessToken)"/>
         <property name="bitlyLink" expression="json-eval($.bitlyLink)" />
         <bitly.init>
            <accessToken>{$ctx:accessToken}</accessToken>
         </bitly.init>
         <bitly.getLinkInfo>
            <bitlyLink>{$ctx:bitlyLink}</bitlyLink>
         </bitly.getLinkInfo>
         <respond/>
      </inSequence>
      <outSequence>
         <send/>
      </outSequence>
   </target>
   <description/>
</proxy>