SugarCRM SupportDocumentationSugar DeveloperSugar Developer Guide 8.0IntegrationWeb Services

Web Services

Overview

Web Services allow for communication between different applications and platforms. Sugar currently supports REST and SOAP APIs. The following sections will outline how to interact with the APIs and what versions of the API we recommend for use. 

Versioning

API versioning is the process of creating a new set of API endpoints for new functionality while leaving preexisting endpoints available for third-party applications and integrations to continue using. This helps to extend the application in an upgrade-safe manner.

Quick Reference

When working with the Web Service API, you should be using the latest API specific to your release. A quick reference of this can be found below:

Release REST Version REST URL SOAP Version SOAP URL
8.0.x v11.1 /rest/v11_1/ v4.1 /service/v4_1/soap.php
7.11.x v11 /rest/v11/ v4.1 /service/v4_1/soap.php
7.10.x v11 /rest/v11/ v4.1 /service/v4_1/soap.php
7.9.x v10 /rest/v10/ v4.1 /service/v4_1/soap.php
7.8.x v10 /rest/v10/ v4.1 /service/v4_1/soap.php
7.7.x v10 /rest/v10/ v4.1 /service/v4_1/soap.php
6.5.x v4.1 /service/v4_1/rest.php v4.1 /service/v4_1/soap.php

Note: As of 7.x, SOAP support is no longer offered with the new APIs. The legacy APIs are still accessible in the product, however, any existing integrations should be updated to use the latest REST endpoints.

Topics

Last modified: 2018-04-28 00:14:24