Open Connections API

OConn is a REST API consisting of a canonical set of URLs and multiple response formats. Because simplicity is a primary goal, there may be certain constraints or limitations in the first version.

Overview

The initial goals for the API are to provide support for the following:

  • Profile management
  • Connections between profiles (friends)
  • Messaging
  • Application installation and interaction

Methods

Profile Methods

Friend Methods

Application Methods

Authentication Methods

Messaging Methods

Formatting

There are two aspects to identifier formatting: URLs and response data. A variety of formatting standards exist in these contexts. They are, roughly:

  • camelCase
  • PascalCase
  • underscore_delimiter
  • nodelimiter

In HTML, no delimiters are the norm. In the XML space, there is variation, but camelCase (e.g., RDF/RSS) seems to be dominant. Many existing REST protocols appear to use underscore delimiters. This is also the convention for a number of URL parameter formats.

To preserve uniformity with other REST APIs, notably Twitter and Open Graph, the working format for the development of the OConn protocol will be underscore_delimited text.

 
api.txt · Last modified: 2010/06/02 02:52 by todd
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki