27 de mayo de 2012

Nuevas funcionalidades para el Códex

Desde el sábado 26 de mayo el Codex tiene una nueva funcionalidad "oculta". A pesar de que cada poco tiempo vamos sacando nuevas funcionalidades, seguro que no somos capaces de imaginar todas las posibles así que pensamos que sería útil que el Codex dispusiera de una API para programadores. 

Si no eres programador o no sabes lo que es una API, simplemente considera que el Codex facilitará ahora que otras personas construyan aplicaciones nuevas sin tener que estar alojadas y controladas en el servidor web del Codex. Podrán utilizar todo el material publicado en el Codex. 

Si eres programador, debes saber que la API consta de momento de dos tipos de peticiones GET basadas en el 'slug' de cada ficha publicada. Así, http://codexdelamarca.com/location/robleda tiene de 'slug' "robleda" y de categoría 'location'. Para tener su versión API, simplemente escribe /api/ antes de la categoría. En nuestro ejemplo: http://codexdelamarca.com/api/location/robleda El resultado es un archivo JSON estándar que o bien muestra un mensaje de error si la consulta no es válida o bien el contenido completo del objeto consultado. 

Además, si el objeto consultado tiene relaciones con otros objetos en el Codex (una de sus virtudes), éstas también aparecen referenciadas. Adicionalmente, permite otra consulta GET para búsquedas sencillas. La sintaxis sería http://codexdelamarca.com/api/search/location/_tu texto aquí_ y _tu texto aquí_ puede ser "la jarra de oro", la jarra de oro, jarra, etc. El resultado vuelve a ser un archivo JSON que puede incluir más de un objeto resultado. De momento la búsqueda sólo funciona dentro de las categorías. 

La API surgió como una forma de exponer todo el contenido de manera más aséptica. Nosotros mismo planeamos usarla para aplicaciones dentro del propio Codex, ya que es buena práctica para desacoplar los desarrollos. Como sabemos que entre los aficionados al rol hay una comunidad respetable de programadores, nos supusimos que podría ser de utilidad anunciarlo. Esta API irá evolucionando poco a poco hasta poder ser un canal directo de comunicación bidireccional con el Codex completo. 

Un saludo.

El equipo del Codex

1 comentario: