Developer Center

GetSyndicationKey API

Approver.com users can retrieve an RSS 2.0-formatted list of the documents contained in their Approver.com queue (as displayed in the user's My Documents page). Retrieving your document queue in RSS format gives you the ability to see when new documents have been added to their queue by other users (typically as a result of an invitation to review or approve). The RSS feed for My Documents is a union of documents you've created, documents you've been asked to review or approve, and documents you've completed. Completed documents are documents created by someone else that you have reviewed or approved.

To obsfucate each user's RSS feed, Approver.com appends a random value, called a syndication key, to the user's RSS URL. You can use the getSyndicationKey API call to retrieve the syndication key for a particular user. Once you have the user's unique syndication key, you can then retrieve the user's RSS feed.

Parameters

This call takes the following query string parameters:

Parameter Description
name The user name of the person for whom you're retrieving the document list. Required. 
password The user's password. Required.

Your application should never request or store user passwords. Storing a user's syndication key is acceptable. If the user's syndication key ever changes, your application will need to handle an error and retry this call. In most cases, however, your application will only need to make this call once.

Return Values

This call returns the following output:

Parameter Description
SyndicationKey The user's syndication key. 
RssUrl The full URL to the user's RSS feed, including the syndication key.

XML Example

This URL executes a getSyndicationKey call.

Here is the return XML from this call.