> Manuales > Manual del API de bit.ly

Notas sobre la utilización del API del servicio web bit.ly que permite acortar URLs y obtener información sobre URLs cortas ya existentes.

En la web existen varios servicios para acortar las URL, esto es, dada una URL cualquiera nos permite obtener otra URL de menor tamaño, que nos redirige hacia la URL original. Uno de estos servicios web se llama bit.ly y resulta bastante interesante, no sólo por las funcionalidades que ofrece, sino también por el API que proporcionan para utilizar el servicio desde otros proyectos. Vamos a presentar unas notas en el presente artículo acerca del mencionado API y ampliaremos la información en el Manual del API de bit.ly.

Quizás muchos de los lectores utilizan ya este servicio web, para acortar las URL que se envían en el texto de los post en Twitter. Como se sabe, Twitter es un servicio de "Microblogging", que permite enviar post de 140 caracteres como máximo. Si dentro de un post de Twitter enviamos una URL ocurre muchas veces que el tamaño de esas URL es tan grande en caracteres que se consume la mayoría del espacio disponible para enviar texto y con ello nuestro post queda muy limitado en espacio y no podemos explicar lo que deseábamos.

Entonces, lo que se suele hacer es acotar la URL, con lo podemos enviar esa URL corta y ganamos espacio para escribir lo que queramos en el micro-post. Quizás esto resulta tan obvio que está de más ofrecer un ejemplo, pero aun así veamos la siguiente URL:

http://www.desarrolloweb.com/actualidad/lista-mundial-pirata-3064.html

Como se puede ver la URL tiene bastantes caracteres, así que lo podemos acortar para obtener la siguiente URL:

http://bit.ly/939UuU

Esta segunda URL más corta nos lleva a la primera URL que era más larga, redirigiendo al navegador de manera transparente para el usuario.

Además de acortar una URL, bit.ly es interesante también porque almacena un registro de todas las URLs que has acortado, ofreciendo datos estadísticos sobre el número de accesos a esa URL corta, los sitios web referidos, etc.

API de bit.ly

El API de bit.ly permite obtener URLs cortas directamente desde cualquier otro sistema informático, sin tener que entrar en el sitio de bit.ly, así como obtener información de URLs que se hayan acortado utilizando este servicio web.

El API que nos ocupa es lo que se denomina un REST API y permite el acceso a recursos del servicio web de bit.ly, a través de URLs en las que enviamos información sobre la acción que queremos realizar. Devuelve un texto que está en formato JSON y opcionalmente en XML, que contiene el resultado de la ejecución del comando enviado en la URL.

Por ejemplo, imaginemos que tenemos una URL larga y deseamos obtener la URL corta correspondiente. Entonces tendremos que componer una llamada al API de bit.ly con los datos de esa URL larga y la operación que queremos realizar con ella (acortarla en este caso). La llamada al API es una URL que tendrá una forma parecida a esta:

http://api.bit.ly/shorten?version=2.0.1&longUrl=http://desarrolloweb.com&login=usuario&apiKey=R_000000000

Como se puede ver, en esta URL estamos enviando varios datos que conforman la consulta al API. Hay uno que resulta claro, "longUrl", en el que enviamos la la URL que deseamos acortar. En la URL se envían otros datos como "version", con la versión del API que estamos utilizando y un par de datos importantes, típicos en el trabajo con APIs como el usuario y la llave, que vamos a explicar a continuación.

Llave del API y usuario

Para acceder al API de bit.ly tenemos que estar registrados en ese sitio web. Cuando hacemos el registro nos proporcionan un nombre de usuario (que elegimos nosotros) y una llave de acceso al API, que es una cadena de caracteres bastante larga.

El registro en bit.ly lleva menos de un minuto y los datos para acceso al API te los ofrecen en la propia página de confirmación del alta de usuario. Para hacer nuestros ejemplos hemos obtenido nuestra propia llave de API, que por razones obvias no vamos a publicar. En los ejemplos que publiquemos el lector tendrá que sustituir estos datos ("login" y "apiKey") por los que le hayan proporcionado.

La llave del API nos permite hacer cualquier uso del servicio web de bit.ly, siempre que no realicemos más de 5 accesos concurrentes al mismo con la misma llave.

Respuesta del API de bit.ly

Una vez que hemos hecho una consulta al API de bit.ly el servicio web nos devuelve un texto, en formato JSON, que contiene varios datos, entre los que se encuentra la URL acortada. Opcionalmente podemos solicitar al API que nos devuelva la información con formato XML, si enviamos el parámetro format=xml.

El texto que recibimos como respuesta tendrá una forma similar a esta:

{ "errorCode": 0, "errorMessage": "", "results": { "http://desarrolloweb.com": { "hash": "tTVQF", "shortCNAMEUrl": "http://bit.ly/c1SivH", "shortKeywordUrl": "", "shortUrl": "http://bit.ly/c1SivH", "userHash": "c1SivH" } }, "statusCode": "OK" }

Nota: El código anterior está en formato JSON y en DesarrolloWeb.com hay varias referencias a esta notación y sobre cómo interpretarla desde otros lenguajes de programación. Para encontrar los artículos puedes utilizar el buscador interno de DesarrolloWeb.com o ir a la entrada de JSON en la Wiki.

Esperamos que esta introducción al API de bit.ly haya resultado interesante, pero seguramente te interese saber algo más sobre sus posibles funcionalidades o cómo utilizarla desde lenguajes de programación como PHP. Así pues, te indicamos que todas las informaciones adicionales las podrás encontrar en el Manual del API de bit.ly.

Miguel Angel Alvarez

Fundador de DesarrolloWeb.com y la plataforma de formación online EscuelaIT. Com...

Manual