API documentation

All methods return results valid only for the current, authenticated user.

Parameters

ac: Required. Specifies the action to be performed (the method name.)

jcb: Optional. Specifies the name of the JSON callback function for JSONP response. When left off, server will echo the results without being wrapped in the callback.

Error reporting

Standard HTTP response codes will be returned in the event of a failed call to the API.

Methods

getAllBookmarks

Retrieves all bookmarks for the current user. Returns the following fields: id, url, url_title, keywords, favicon, created_date, and category_name. No sorting order is applied to the results.
http://ryebox.com/api/index.php?ac=getAllBookmarks&jcb=?

getAllBookmarksH

Retrieves all bookmarks for the current user, arranged hierarchically with subcategories embedded into parent categories. Returns the following fields for type="bookmark": id, type, url, url_title, keywords, favicon, created_date, and category_name. Returns the following fields for type="category": id, type, name, user_id, live_rss, is_public, sort_by and parent_id. (Note: parent_id will be 0 for main categories.) Bookmarks will be sorted in each category according to user preferences.
http://ryebox.com/api/index.php?ac=getAllBookmarksH&jcb=?

getFavorites

Retrieves the bookmarks listed as favorites for the current user. Returns the following fields: id, url, url_title, keywords, favicon, created_date, and category_name.
http://ryebox.com/api/index.php?ac=getFavorites&jcb=?

getTimezone

Retrieves timezone information for the current user. Returns the following fields: country_city, gmt_hours, and description.
http://ryebox.com/api/index.php?ac=getTimezone&jcb=?

getPreferences

Retrieves account preferences for the current user. Returns the following fields: id, nick, name, email, pref_animated, pref_rss_fav_enabled, pref_ispublic_fav_enabled, pref_rss_ls_enabled, and pref_addls_by_default.
http://ryebox.com/api/index.php?ac=getPreferences&jcb=?

getRecentBookmarks

Retrieves recently created bookmarks for the current user. Optional "limit" parameter restricts the number of records returned to the value specified. If "limit" is left off, method returns a default of 10 records. Returns the following fields: id, url, url_title, keywords, favicon, created_date, and category_name.
http://ryebox.com/api/index.php?ac=getRecentBookmarks&limit=50&jcb=?

Example code using jquery:

<script>
  $(function() {
    $.getJSON("http://ryebox.com/api/index.php?ac=getAllBookmarks&jcb=?",
      function(data) {
        console.log (data);
      }
    )
  });
</script>

Example page code using jquery to retrieve the last ten added bookmarks:

View this page live here.
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" " http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd ">
<html xmlns=" http://www.w3.org/1999/xhtml ">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<script type="text/javascript" src="jquery-1.6.2.min.js"></script>
</head>
<body>

<div id="bookmarks">
loading...
</div>

<script type="text/javascript">
  $(function() {
    $.getJSON("http://ryebox.com/api/index.php?ac=getRecentBookmarks&jcb=?",
      function(data) {
        totalcode = "Bookmark list<ul>";
        for (item in data) {
          bookmark = data[item];
          totalcode += '<li><a href="'+bookmark.url+'">'+bookmark.url_title+'</a> (Keywords: '+bookmark.keywords+'. Created on '+bookmark.created_date+'.)<br>';
            }
        totalcode += "</ul>";
        document.getElementById("bookmarks").innerHTML = totalcode;
        }
    );
  });
</script>


</body>
</html>