The Orkut v2 REST API is an HTTP-based API that allows developers to access select Orkut features. From the standpoint of features, it is an extension of the JSON-RPC off-site application API, but from the point of view of protocol, it is considerably different.
Based on modern REST concepts, this API allows developers to access Orkut features using HTTP semantics through straightforward requests. For more information about the specific requests and URLs, please refer to the Orkut REST API reference.
The REST API allows developers to access the following Orkut features:
- Activity Stream listing (consistent with the web site): applications can retrieve an activity stream listing that closely correlates to what users view on the website. This is usually much more relevant than the narrower activity stream listing available via the JSON-RPC API.
- Activity Comments: applications can interact with comments on any activity (retrieve, create, and delete comments on individual activities).
- Improved scrapbook access: the scrapbook can be directly accessed from the REST API, enabling applications to retrieve a more consistent listing of a user's scraps.
- Badges: applications can list the badges that a given user has, and can query information about individual badges.
- ACLs: applications can manipulate visibility (access control lists) of activities and scraps.
Integration with the JSON-RPC API
The Orkut v2 REST API is not currently a replacement for the JSON-RPC API but, rather, an extension. It offers a way to access certain Orkut features which were not available in the existing APIs, and offers a more consistent way to access certain features that were already available.
Entity ID's are consistent across both APIs and no serialization or deserialization is required, which makes integration painless.
The REST API is compatible with both OAuth 1.0 and OAuth 2.0. If you use OAuth 1, you use the same authentication token for both the REST API and the JSON-RPC API, this means that the same token can be shared across calls to both APIs. If you use OAuth 2.0, however, you will not be able to share the same token across both APIs.
For more information about the calls supported by the API, including syntax, URLs, and entity definitions, please refer to the Orkut REST API reference.