General information regarding RPM API capabilities


 

The RPM API allows another system to read and update information in RPM. The capabilities include:

  • Submit a monthly payout list to an accounting system
  • Download daily changes from an RPM process to a local SQL database for reporting
  • Synchronize customers and orders between Salesforce and RPM
  • Synchronize shared contacts with an Office 365 Outlook subscription
  • Synchronize forms in processes in two different RPM subscriptions
  • Provide an IP phone system with the ability to popup customer information from RPM based on the incoming or outgoing phone number.
  • Add, read, edit accounts
  • Add, read, edit customers and their locations and contacts
  • Read supplier and agency information
  • Update user passwords
  • Add, read, edit process forms, actions, and worksheets
  • Read commission summaries by agency, rep, customer, and account

  

No commission itemsWe do not have an API to get specific commission details and line items out of RPM so that the API cannot be used to replace RPM.


Who builds it?


RPM Software has a full time developer, dedicated to building API solutions. This allows us to act as your custom developer. However, some of our clients, who have in-house programmers or consultants have built their own solutions using our API. To assist with this scenario, we have code examples and a full reference site at api.rpmsoftware.com.


How much does it cost?


The API functionality is included in RPM subscriptions at no extra cost for normal usage(1). The API solution will have costs associated with building, maintaining, and possibly hosting the solution. Custom API solutions vary too widely to provide an average cost For example, adding a form to a website that sends data to RPM may take less than an hour and require no ongoing resources outside of the website itself. On the other end of the spectrum, an integration with SAP or a custom mobile app will likely require a team of people and a plan to handle ongoing changes on either side.


Technical details


RPM has a REST API that uses simple HTTPS POST requests of JSON data(2). REST using JSON has emerged as the dominant form of APIs for modern web applications(3). It is easy to use in many programming languages and environments.

See api.rpmsoftware.com for more technical details and a complete list of endpoints with data and code examples.





1. The API system has user and monthly limitations built in to protect from abuse. A particularly demanding integration idea may require extra server resources beyond what is included in a normal subscription. To date no RPM client has ever exceeded these limits. Even our heaviest API users have not come close.

2. Base64 encoding is used when sending or receiving binary files as part of the JSON.

3. Compared to SOAP and WSD