API

From RPM Wiki

Table of contents
1 Summary
2 Getting started

2.1 Keys
2.2 URL
2.3 Request
2.4 Response

3 Calls
4 Code examples
5 Limit
6 Security

6.1 Access by API
6.2 Staff users

[edit]

Summary

The API is used to integrate RPM with other systems. It requires a programmer to use, but is not complicated. API functionality is included with every RPM subscription.

  • Our API uses REST (http://en.wikipedia.org/wiki/Representational_State_Transfer). This allows you to interact with RPM using simple HTTP POST requests.
  • All data in and out is in JSON (http://en.wikipedia.org/wiki/JSON) format.
[edit]

Getting started

[edit]

Keys

Using the API requires a key for authentication. You can create multiple keys and each one is linked to a staff user to define its security.

  • Keys are under Management > Api
  • A key is like combined username + password to your RPM subscription, keep it secure.
[edit]

URL

All API calls are done through one service with the call name added to the end.

[edit]

Request

The POST method is required. The POST data is a JSON object 

{
  "Key": "{api key}"
}

Example: 

{
  "Key": "12345678-1234-1234-1234-123abc"
}

Some calls will require more properties in the JSON object. Each call has a wiki page that explains the requirements in detail with examples. (see "Calls" below)

[edit]

Response

A JSON string is returned inside a JSON object 

{
  "{call response}":
  "{the response data"
}

Example: 

{
  "InfoResult":
  "{
    "Subscriber":"Test, Inc.",
    "RPM":"AGENT",
    "Role":"Executive",
    "User":"johnsmith"
  }"
}
[edit]

Calls

[edit]

Code examples

[edit]

Limit

Every subscriber has a monthly API call limit. Our goal is that reasonable use of the API be included based on your current RPM subscription fee. Until July 2010, the limit will not be enforced as we determine what the limits will be.

A limit is required so that a subscriber with a low user count and thus low subscription rate can't monopolize a server with unfair API use.

[edit]

Security

[edit]

Access by API

  • Uses the staff user role of the user assigned to the API key
[edit]

Staff users

  • API management requires the "Add, manage API keys" privilege.
Retrieved from "http://rpmsoftware.com/wiki/index.php/API"
  • This page was last modified 15:18, 15 Apr 2010.
  • This page has been accessed 4386 times.