cort.as ofrecido por

API para CORT.AS

El API de CORT.AS es extremadamente sencillo e irá creciendo poco a poco, según vayamos añadiendo nuevas funcionalidades.

Codificar una URI

Te permite acceder a la funcionalidad principal de CORT.AS: dada una URI, convertirla en otra más corta. Por ejemplo, pasar de

http://www.elpais.com/articulo/sociedad/Dejare/parte/pequena/dinero/hijos/elpepisoc/20100605elpepisoc_4/Tes

a

http://cort.as/005v

Para ello debes llamar a http://cortas.elpais.com/encode.pl con los siguientes parámetros:

  • u: tu URI original. O sea, aquella que quieres codificar.
  • k: tu clave pública para acceder al API; la tienes en la página de tu perfil de elpais.com. Esto sólo lo necesitarás si quieres se hagan estadísticas de uso de tu nueva URL.
  • t: si has usado el parámetro anterior (o sea, estás autenticado), indicará si quieres que se hagan estadísticas del uso de tu nueva URL, o sea seguimiento de clicks. Debe contener 0, si NO lo quieres, o 1, si Sí lo quieres. Por defecto es 0.
  • r: formato en el que quieres que contestemos a tu petición. Las opciones son: html, json, xml o txt.

Ejemplos de codificación son:

http://cortas.elpais.com/encode.pl?u=http://www.google.com/&r=json
http://cortas.elpais.com/encode.pl?u=http://www.yahoo.com/&r=xml

http://cortas.elpais.com/encode.pl?u=http://www.elpais.com/

En todos los casos salvo html —que volcará una página HTML completa— los campos devueltos son:

  • status: contendrá ok o error.
  • errorLong: sólo aparecerá si status fue igual a error y contedrá una explicación de qué falló.
  • urlCortas: la nueva URL corta.
  • uriOriginal: la URI que tú has enviado.
  • tracking: contendrá 0 o 1, según tu elección.

Los ejemplos de contestación son:

Formato txt:

status: ok
urlCortas: http://cort.as/FU
uriOriginal: http://www.elpais.com/
tracking:0

Formato json:

{'status':'ok','urlCortas':'http://cort.as/FU','uriOriginal':'http://www.elpais.com/','tracking':0}

Formato xml:

<cortas>
<status>ok</status>
<urlCortas>http://cort.as/FU</urlCortas>
<uriOriginal>http://www.elpais.com/</uriOriginal>
<tracking>0</tracking>
<urlOriginal>http://www.elpais.com/</urlOriginal>
</cortas>

Descodificar una URL

Dada una URL de CORT.AS, te permite conocer la original y, por tanto, poder saltar a ella

Los formatos de respuesta son los mismos que en el caso anterior: html, json, xml o txt. También, como en el caso anterior —y a excepción de html (que imprimirá una página completa HTML, informando de la URI a la que hay que saltar)— los campos devueltos son:

  • status: contendrá ok o error.
  • urlCortas: la URI corta a la que saltar. Esta URI será la URL de error de CORT.AS si status ha sido erróneo.

Si no se indica formato preferido, automáticamente se hará la redirección a la URI destino.

La llamada debe tener la siguiente pinta:

<URL_corta>[.html|.json|.xml|.txt]

Ejemplos:

http://cort.as/FU
http://cort.as/FU.xml
http://cort.as/FU.json
http://cort.as/FU.txt

Estadísticas de clicks

Cuando se acorta un URI y se está autenticado, existe la posibilidad de activar el seguimiento de clicks. Con esto conseguiremos estadísticas de cuantas veces se ha usado esa nueva URL acortada.

Los formatos de respuesta son tres: json, xml o txt. En este caso no hay HTML porque lo que se devuelven son datos tabulados y, para eso, ya está el formato de texto plano.

Los parámetros son:

  • c: la URL de la que se quire estadísticas.
  • t: define la horquilla de la estadística. Existen 5 posibilidades
    • última hora: t igual a 10.
    • últimas 24 horas: t igual a 20. Es la opción por defecto
    • última semana: t igual a 30.
    • último mes: t igual a 40.
    • Todo el periodo: t igual a 50.
  • r: formato en el que quieres que contestemos a tu petición. Las opciones son las ya dichas: json, xml o txt.

Ejemplos, la llamada http://cortas.elpais.com/stats.pl?c=http://cort.as/1&r=json&t=40 devolvería un JSON tal que:

{
"status": "ok",
"totalclicks": 81,
"clicks":[{
"date": "20090225",
"value": 1
},{
"date": "20090226",
"value": 24
},{
"date": "20090227",
"value": 32
},{
"date": "20090302",
"value": 14
},{
"date": "20090303",
"value": 10
}]
}

Si la llamada fuera con salida en XML, sería:

<cortas>
<status>ok</status>
<totalclicks>81</totalclicks>
<clicks>
<data>
<date>20090225</date>
<value>1</value>
</data>
<data>
<date>20090226</date>
<value>24</value>
</data>
<data>
<date>20090227</date>
<value>32</value>
</data>
<data>
<date>20090302</date>
<value>14</value>
</data>
<data>
<date>20090303</date>
<value>10</value>
</data>
</clicks>
</cortas>
¿Sugerencias? || v.20100606 || http://cortas.elpais.com/api-cortas.html