Please note: this is very much in beta, so let me know if you have any problems or requests.
This is the API for http://lib.rario.us.
These should all be RESTful.
Some methods will require Authentication.
Data will return in JSON by default.
If you pass a “callback” param, the data will be passed to a function using the callback value for the function name.
You can easily use cURL in the command line to test out responses.
Methods that require writing or deleting require authentication. This currently uses basic HTTP auth methods.
Many of these methods will return a HTTP 204 No Content
on failure.
Methods that destroy or edit data require a POST.
Methods for interacting with the user data.
lib.rario.us/api/user/show
This method requires either id
or screenname
and returns JSON (by default) or XML using the format
parameter.
Parameter | Type |
---|---|
id | integer - a user's id |
screenname | string - a user's name |
format | either 'xml' or 'json' - defaults to 'json' |
Methods for interacting with libraries.
lib.rario.us/api/media
Parameter | Type |
---|---|
owner | string - a username on lib.rario.us |
type | string - 'books', 'dvds', 'music', or 'games' |
tag | string - separate multiples tags with a ”+” |
page | integer - for page number |
format | either 'xml' or 'json' - defaults to 'json' |
Methods for interacting with item data.
lib.rario.us/api/item/show
id
Parameter | Type |
---|---|
id | integer - an items id |
format | either 'xml' or 'json' - defaults to 'json' |
lib.rario.us/api/item/add
ASIN
id
true
on success or a HTTP 204 No Content
lib.rario.us/api/item/delete
Parameter | Type |
---|---|
id | integer - an items id |
Methods for interacting with tags
lib.rario.us/api/tags/show
Parameter | Type |
---|---|
user_id | integer - a user's id |
screenname | string - a user's name |
format | either 'xml' or 'json' - defaults to 'json' |
Methods for interacting with titles
lib.rario.us/api/title/show
Parameter | Type |
---|---|
id | integer - a title's id |
asin | string - a title's amazon id |
upc | string - a title's UPC |
ean | string - a title's EAN |
isbn | string - a title's isbn |
format | either 'xml' or 'json' - defaults to 'json' |
Methods for interacting with lib.rario.us's amazon methods
lib.rario.us/api/amazon/search