UPDATED: 6/30/2011 – Includes information on the v4 API
UPDATED: 10/5/2012 – Includes information on the v4_1 API
A big question we have heard from developers lately is what’s the deal with the multiple web services APIs available. Which one should be used for development? What Sugar versions contain the a particular version of the API? And why did we create this whole mess?
Let me start off by explaining the rationale behind having many versions of the API. For developers, having a consistent and stable API is very important. Our web services API establishes a contract between you the developer and us the API producer, and part of that contract is not changing the terms of how it works. In that light, we made the decision last year when we released Sugar 5.5 that the API will never change going forward, but that if we decide to add new functionality or change existing functionality, that we instead create a new version of the API for you to use, leaving the old version intact. This means that upgrading Sugar versions will not break your web service code.
Below is a quick chart that outlines the various APIs available as of the latest version of Sugar released, and more information about them. We’ll keep this updated with any corrections or information on new API versions as they come out.
|API version||Entrypoint(s)||Minimum Sugar Version||Changes from previous|
|5.5||See documentation at http://developers.sugarcrm.com/docs/OS/6.1/-docs-Developer_Guides-Sugar_Developer_Guide_6.1.0-Chapter%202%20Application%20Framework.html#9000303. For most people, this is the version you want to use.|
|6.0.2||Adds the following to the v2 API:
- Fixed problems with .NET clients not being able parse SOAP call response.
|6.0.1||Adds the following to the v2 API:
- Added method get_module_fields_md5
|6.1.0||Adds the following to the v3 API:
- Added parameter track_view to get_entry
|6.2.0||Adds the following to the v3_1 API:
- Fixed more problems with .NET clients not being able parse SOAP call response. If you use .NET this is the version you should be using.
|6.4.1||Adds the following to the v4 API:
- Adds pagination support for get_relationships
Recommended version to use for all clients.