Archive for the ‘json’ Category

Sunday, July 6th, 2008

Introducing the LibraryThing books API

See bottom of post for updates…

I’ve just finished a first draft of a JSON-based API for book data, created a test page and typed up some basic documentation.

What is this for? The API gives you Javascript access to your book data. The most obvious use of this would be to create new, much better widgets. At first, we expect this to interest programmers, but as new widgets are developed, non-programmers will get cool things. I started by redoing our traditional widgets in a new way here. That’s the base, not the ceiling!

How does it work? Every user can retrieve their data, in JSON format—basically as a ready-made JavaScript data structure. You control what is returned—books, tags, ratings, etc.—how it’s sorted and so forth. By default we give you a standard library of functions to parse and display the data. You can use it, build on it or start from scratch. Find out more here.

What’s great? All our code for processing the JSON API has been and will be released as open source—available for use, reuse and modification. Better—since we’re not the best programmers, particularly in JavaScript!—we are requiring any software that builds upon the API to be released under similar terms, so everyone can take advantage of improvements and advances. 

Does this make code look sexy?

What’s the catch? The API is not intended for making backups or exporting your data to other programs. For that, use our CSV and TSV export functions, from the Tools tab. We are licensing the JSON API for browser-use only. This is about our data licenses. In-browser widgets have never drawn ire from our data providers.

Where can this go? This is just getting started. Everything can be expanded and improved. As members want new or different data, I will be only too happy to add it to the API. But the most interesting development will probably come from members, not LibraryThing employees.

I have created a LibraryThing API Development group to discuss the API, work through code and come up with new ideas.

At a minimum, I can see:

  • New widget types, like widgets showing your most recent reviews.
  • Widgets that take you to libraries, and other places other than LibraryThing. (Libraries have been clamoring for this for ages. Many use LibraryThing to feature new books on the website, and want the links to go to their catalog, not LibraryThing.)
  • New result sets, for your tags or authors (separate from our books), your book’s works, series info, etc.
  • Integration with other JS-based APIs, like Google Book Search.

What if I’m not a programmer? No problem. Come and LibraryThing API Developmenttell us what you want. We’ll help you, or maybe someone else will.


UPDATE: I’ve made some changes to the programming, changing how the code is structured and adding result sets for reading dates. We also have the first outside use of the API, a very promising—if not perfect—cover flip test by MMcM (here). Follow what’s going on in the LibraryThing API Development group.

Labels: api, apis, books api, javascript, json, member projects

Tuesday, March 25th, 2008

New JSON API

I’ve just blogged about a new Javascript/JSON API for work info over on Thingology, LibraryThing’s blog for ideas, issues, libraries and labs.

It’s mostly designed to make it easy for people to link to LibraryThing only when we have the book. You can also dress up the link with copy- and review-counts, and an average rating.

I think regular members will be more excited by a JSON API to your own books. This will allow us and members to write new widgets—widget for reviews, for example—and better widgets. I’m want to write them so that all the JavaScript code that comes out it is automatically shared between members, both legally and technically.

The work-info API is a first step. Let’s talk about this and what should come.

Labels: apis, json, widgets