Differences

This shows you the differences between two versions of the page.

librarious:api [2009/09/06 17:58]
mauayan added json section talking about callback param
librarious:api [2010/05/18 16:14] (current)
mauayan added link to lib.rario.us
Line 1: Line 1:
====== lib.rario.us API ====== ====== lib.rario.us API ======
-Please note: **none of this is live yet**, I'm just getting some of the documentation in place in preparation for the launch of lib.rario.us<html>&sup2;</html>.+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. These should all be RESTful.
Line 7: Line 9:
Some methods will require [[:librarious:api#authentication|Authentication]]. Some methods will require [[:librarious:api#authentication|Authentication]].
-The API is *very* much in alpha, so let me know if you have any problems or requests. 
===== JSON ===== ===== JSON =====
Data will return in JSON by default. Data will return in JSON by default.
-If you pass a "callback" param, the data will be wrapped in a function call using the callback value for the function name. +If you pass a "callback" param, the data will be passed to a function using the callback value for the function name.
===== Using cURL ===== ===== Using cURL =====
Line 24: Line 25:
Many of these methods will return a <html><code>HTTP 204 No Content</code></html> on failure. Many of these methods will return a <html><code>HTTP 204 No Content</code></html> on failure.
- +Methods that destroy or edit data require a POST.
Line 44: Line 44:
 +==== Media Methods ====
 +Methods for interacting with libraries.
 +=== Media Index ===
 +<code>lib.rario.us/api/media</code>
 +
 +==Requires==
 +
 +^ 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'    |
Line 102: Line 115:
<code>lib.rario.us/api/title/show</code> <code>lib.rario.us/api/title/show</code>
 +^ 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'    |

Personal Tools