Acceso mediante API al etiquetado

A principios de este mes liberábamos el acceso a nuestra herramienta de etiquetado y prometíamos un API en breve. Aquí está :).

Sinceramente, no es que la salida en JSON o XML no estuviese preparada desde el principio, por supuesto que lo estaba (aunque sólo fuera para poder usarla desde nuestros editores). El problema estaba en que debíamos preparar el resto de nuestro chiringuito para que, además de la clave que ya tenéis para autenticaros ante el sistema, todos vosotros tuvierais una clave pública y otra privada (llamémoslas así aunque estrictamente no lo son, pero eso es harina de otro costal). Todo eso ya está, así que es el momento de dar acceso al etiquetado a través de API.

Dos formatos de salida

Dependiendo de los gustos, manías o, quién sabe, tecnología, dos posibles formatos de salida (además del ya conocido html):

json: con una salida accesible desde cualquier JavaScript con el siguiente aspecto

xml: formato adecuado para cualquier otro lenguaje de programación

Formato de la llamada

El formato de la llamada que se debe usar (ya sea con GET o POST) debe contener los siguientes parámetros:

• q (obligatorio): texto del que se quiere obtener la sugerencia de etiquetas.
• c: codificación usada en q. Dos posibles valores: utf8 o iso-8859-1. Por defecto, se tomará este último valor.
• r: formato de salida. Debe contener xml, json o html. Por defecto, se tomará este último valor.
• k: clave pública. Está disponible en la página de perfil de cada usuario. Este campo es obligatorio si no se está autenticado de manera tradicional ante www.soitu.es

O sea, por ejemplo, para hacer la consulta anterior de XML, los parámetros a pasar serían:

Por supuesto, la llamada debe ir contra http://www.soitu.es/.

Recordad que este etiquetado lo hace una máquina, debe servir como una ayuda, que mucho mejor cuanto más descriptivo sea el texto y, sobre todo, la necesaria supervisión humana que confirme las sugerencias.

* Raúl Rivero es el director técnico de soitu.es