Rummble Documentation

1. Getting started

1. Register for a developer user account.
2. Register your application to get your personal API key.
3. Start coding — be sure to use your API KEY to make your API calls.

2. Intro

The API uses a REST interface. This means that our Rummble method calls are made over the internet by sending HTTP GET or POST requests to the Rummble API Rest server (http://api.rummble.com) . Nearly any computer language can be used to communicate over HTTP with the REST server.

• The Rummble API consists of a set of callable methods.
• To perform an action using the Rummble API, you need to send a request to its server specifying a method and some arguments, and will receive a formatted response.
• All API methods, listed on the API index page, take a list of named parameters.
• The REQUIRED parameter method is used to specify the calling method.
• The REQUIRED parameter oauth_consumer_key is used to specify your API key.
• The optional parameter format is used to specify a response format.
• The REQUIRED parameter oauth_nonce is a unique identifier for the request. The current timestamp could be used.
• Most API calls require user authentication. See the Authentication guide for more details.
• All API calls must be signed using a REQUIRED parameter oauth_signature. See the Signature guide for more details.
• The arguments, responses and error codes for each method are listed on the method's spec page.
• All API calls could return an error response. For more details about this please see the Error codes page.

The web service is located at: http://api.rummble.com

Example Request

3. Response Formats

Currently the response formats available are:

• XML
• JSON

4. Encoding

The Rummble API expects all data to be UTF-8 endcoded.

5. Prerequisites

Any applications wishing to use the Rummble API must have already obtained a Rummble API key. You can apply for an API Key here. In addition, they must configure the following settings, attached to the API key:

• Application title
• Application description
• Application type

A 'shared secret' for the API key is then issued by Rummble. This secret is used in the signing process, detailed in the Signature guide.

Applications can then choose one of two authentication methods - web based or non-web based. Each application key may only be associated with a single authentication method.

6. Request Limit

We limit the number of requests so we can manage demand for the service to deliver the best performance.

• Limit calls to 5,000 per day, per API key
• Limit queries to 2 per second, per API key

7. Wrappers

• An example using the Signpost Java library can be found here
• An example using the Scribe Java library can be found here