bkkeepr | API

The bkkeepr API

We now have an API, which you can use to extract data from bkkeepr and build fun applications around it.

Please note: This is all provided as-is, with no promises, no guarantees, nothing like that. It's an experiment, and please treat it like that. Bad usage will result in suspension, and commercial use is only permitted by prior consent. Feedback is very welcome.

There's a post at booktwo.org with some initial thoughts and suggestions. More details - and perhaps an example application - to come, but here's the basics:

User data

You can retrieve a specific user's data, in either JSON or XML, by calling one of these endpoints, depending on which format you're after:

http://bkkeepr.com/api/user/USERNAME.json

http://bkkeepr.com/api/user/USERNAME.xml

Here's an example response for http://bkkeepr.com/api/user/stml.json:

[
    {
        "isbn":"0140034382",
        "title":"The Glass Bead Game (Penguin Modern Classics)",
        "author":"Hermann Hesse",
        "note":"Hesse introduces the game",
        "time":"2008-08-17 22:47:44",
        "page":"27"
    }
    ...
]

And for http://bkkeepr.com/api/user/stml.xml:

<?xml version="1.0" encoding="UTF-8"?>
    <user>
        <record>
            <isbn>0140034382</isbn>
            <title>The Glass Bead Game (Penguin Modern Classics)</title>
            <author>Hermann Hesse</author>
            <note>Hesse introduces the game</note>
            <time>2008-08-17 22:47:44</time>
            <page>27</page>
        </record>
        ...
    </user>

It should all be pretty self-explanatory to geeks, with a couple of caveats:

the note field may be empty if there's no note (most will be, in fact)
the page field may be a 0 (zero) if the book has just been started, a page number if that's been noted, or the word 'finished'

Book data

You can retrieve all the data for a specific book, again in either JSON or XML, by calling one of these endpoints, depending on which format you're after:

http://bkkeepr.com/api/book/ISBN.json

http://bkkeepr.com/api/book/ISBN.xml

Here's an example response for http://bkkeepr.com/api/book/0140034382.json:

[
    {
        "name":"stml",
        "note":"Hesse introduces the game",
        "time":"2008-08-17 22:47:44",
        "page":"27"
    }
    ...
]

And for http://bkkeepr.com/api/book/0140034382.xml:

<?xml version="1.0" encoding="UTF-8"?>
    <book>
        <record>
            <name>stml</name>
            <note>Hesse introduces the game</note>
            <time>2008-08-17 22:47:44</time>
            <page>27</page>
        </record>
        ...
    </book>

The same caveats apply as to the user data.

Thanks

To intranation, and others. They are not to blame.