General Information Regarding RPM API Capabilities


 

The RPM API allows another system to read and update data in RPM. Some possible use cases for the RPM API 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, and edit accounts
  • Add, read, and edit customers and their locations and contacts
  • Read supplier and agency information
  • Add, read, and edit process forms
  • Read commission summaries by agency, rep, customer, and account


For a complete list please view Enhancements and Enhancement Use Cases.

  

No commission itemsWe do not have an API to get specific commission details and line items out of RPM so 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


If you decide to build a program using the RPM API, RPM will not troubleshoot or provide support for your code. Please contact support if you feel that the API is not functioning according to the documentation. 


How Much Does it Cost? 


An API user will be required to use the API. The cost for this user will be defined in your Order.


Any API solution RPM builds for you 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, integration with Salesforce will likely require a team of people and a plan to handle ongoing changes on either side. 


Please contact support if you are interested in utilizing RPM API project resources. 


RPM provides API services at $150/hour.


Technical Details 


RPM has a REST API that uses simple HTTPS POST requests of JSON data. REST using JSON has emerged as the dominant form of API for modern web applications. 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.