Page Summary

Learn how to obtain an API key, access endpoints, and construct a call.


Keys

Using the API requires a key for authentication. Each key is linked with one API user; access to the data will be linked to the same access level of the API user role.


  • To obtain or create new keys navigate to Top Menu >> Setup >> API and add an API User.
  • Note: A key is like a combined username + password to your RPM subscription. Keep it secure.

Call Usage

RPM API usage is governed by monthly call plans. Plan and current usage data is displayed on this page after access is enabled. Exceeding a monthly plan will result in overage fees. Plan usage count will reset monthly on the date displayed below the monthly usage counter. 


  • To be notified before overages occur assign an enabled staff user to be notified when the usage reaches 65%, 80%, 90%, and 100% of the monthly plan. Navigate to Top Menu >> Setup >> API >> Usage notifications and assign a staff user to receive email notifications. 
  • Note: It is strongly recommended that you add at least one user to be notified on API call usages.


API Access URL And Endpoints

All the API calls are done through one web service, available at the following URL:

RPM Telco:

https://secure.rpmtelco.com/rpm/api2.svc/<api-endpoint>

API Usage Limit

As of RPM 33.1, the RPM API has no usage limits. Instead, subscribers choose a monthly usage plan. Exceeding it will not limit usage but overage fees will apply. More information here: RPM API Access and Usage.


How to Construct a Request to Our API

All the requests to the API are done using JSON formatting and the HTTP POST method is required.

Every request sent to the API requires the call parameters to be provided in JSON format. Regardless of what endpoint you are trying to request, you need to provide the API key in the HTTP request header in the following way:

1
2
3
4
5
6
POST https://secure.rpmtelco.com/rpm/api2.svc/<api-endpoint>
RpmApiKey: ffffffff-ffff-ffff-ffff-ffffffffffff
 
{
    ... other data
}

Any request with a missing API Key will respond with an error:

1
2
3
4
5
{
  "Result": {
    "Error": "Valid key required"
  }
}

Invalid keys produce errors too:

1
2
3
4
5
{
  "Result": {
    "Error": "Key not found.  A valid \"Key\" must appear as the first input data item."
  }
}

Example Request:

1
2
3
4
POST https://secure.rpmtelco.com/rpm/api2.svc/Info
RpmApiKey: 12345678-1234-1234-1234-123abc
 
{}

Response

1
2
3
4
5
6
7
8
9
{   
  "InfoResult":
    {     
      "Subscriber":"Test Inc.",
      "RPM":"AGENT",
      "Role":"Executive",
      "User":"johnsmith"  
    } 
}


Further Reading