This is an old revision of the document!


lib.rario.us API

Overview

These should all be RESTful.

Some methods will require Authentication.

The API is *very* much in beta alpha, so let me know if you have any problems or requests.

Using cURL

You can easily use cURL in the command line to test out responses.

Authentication

Methods that require writing or deleting require authentication. This currently uses basic HTTP auth methods.

API Methods

Many of these methods will return a HTTP 204 No Content on failure.

User Methods

Methods for interacting with the user data.

User Show

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'

Item Methods

Methods for interacting with item data.

Item Show

lib.rario.us/api/item/show
Parameter Type
id integer - an items id
format either 'xml' or 'json' - defaults to 'json'

Item Add

lib.rario.us/api/item/add

Item Delete

Requires:

  • authentication
  • a POST
  • an item's id

Returns: true on success or a HTTP 204 No Content

lib.rario.us/api/item/delete
Parameter Type
id integer - an items id

Tag Methods

Methods for interacting with tags

Tag Show

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'

Title Methods

Methods for interacting with titles

Title Show

lib.rario.us/api/title/show

Amazon Methods

Methods for interacting with lib.rario.us's amazon methods

Amazon Search

lib.rario.us/api/amazon/search

Personal Tools