CRM API Version 3.0
The CRM API version 3.0 is a RESTful (Representational State Transfer) API allowing you to make requests to Create, Read, Update and Delete your CRM edition’s records.
A new version of our API is now available, API Version 4, and customers should now use this.
The following record types can be Created, Read, Updated and Deleted via the Really Simple Systems CRM API v3.0 (depending on the pricing plan you are using and the modules you have enabled):
|Record Type||Price Plan|
|Accounts||All Price Plans|
|Activities||All Price Plans|
|Contacts||All Price Plans|
|Campaigns||Starter, Professional, and Enterprise Plans (with Marketing module)|
|Campaign Details||Starter, Professional, and Enterprise Plans (with Marketing module)|
|Campaign Stages||Starter, Professional, and Enterprise Plans (with Marketing module)|
|Cases||Professional and Enterprise Plans (with Service & Support module)|
|Documents||All Price Plans|
|Opportunities||All Price Plans|
|Opportunity Histories||All Price Plans|
|Opportunity Lines||All Price Plans|
The CRM API v3.0 can accept your requests in either JSON or XML formats. You will need to understand how to make HTTP requests in order to use the API although we have provided some introductory information and useful links (in addition to a comprehensive guide to the methods available to you) in our API v3.0 Documentation PDF to assist you or your developers.
Enabling the CRM API v3.0
The CRM API v3.0 needs to be enabled for you to be able to use it. You can create and manage your API keys under Settings / Integrations, then open API Access.
Some customers may still be using Version 1 of the API or Version 2 both of which utilise Simple Object Access Protocol (SOAP). If you are migrating from a previous version of the API please ensure that you test your existing systems using the Sandbox Mode in v3.0 (which is explained in the API documentation) before using the API to make changes to your live data.
Download the Documentation
Download the CRM API Documentation v0.9.3. The documentation includes a guide to getting started which outlines the various features and modes available within the API; code samples to help you configure your application to use the API; information about authentication; and a comprehensive guide to the methods available and how you should structure your data when making requests.
If you require any additional information please contact your account manager or the support team who will be happy to help you.
What is an API?
API stands for Application Programming Interface and is a set of programming instructions and standards for accessing a Web-based software application. A software company releases its API to the public so that other software developers can design products that are powered by its service.
For example, Amazon.com released its API so that web site developers could more easily access Amazon’s product information. Using the Amazon API, a third party web site can post direct links to Amazon products with updated prices and an option to “buy now.” Read – How Stuff Works.
Enabling the API
The API needs to be enabled for your CRM system for you to use it. To create and manage your API keys, go to Settings / Integrations, then API Access.
The Really Simple Systems CRM API v3.0 is now available. While Version 2.0 of the API continues to be supported, new customers should use Version 3.0 and existing users should switch to the current version as soon as possible.