About Web Services

Sage CRM Web Services API (Application Programming Interface) enables developers to manipulate records in Sage CRM with SOAP (Simple Object Access Protocol) over HTTP using XML (Extensible Markup Language).

Developers can use the Sage CRM Web Services API to do the following:

  • Programmatically create, read, update, and delete entity records in the Sage CRM database. For example, Companies, People, Opportunities, Cases, Quotes, and Orders.
  • Integrate third-party applications used within your organization with Sage CRM.

Sage CRM Web Services provide a standardized method for integrating web-based applications using the following components via an Internet protocol backbone:

  • XML. Tags the data.
  • SOAP. Transfers the data. For detailed information about SOAP, go to http://www.w3.org/TR/SOAP.
  • WSDL. Describes the available services.

Web Services allow organizations to exchange data without in-depth knowledge of the IT systems behind the firewall. Web Services don't provide users with a GUI, which is the case with traditional client/server models. Instead, Web Services share business logic, data, and processes through a programmatic interface across a network. Developers can add the Web Services to a GUI, such as a web page or an executable program, to provide users with the required functionality. The technology makes it possible for applications from different sources to communicate with each other without time-consuming custom coding. All communication is in XML, so you aren't limited to any one programming language.

To use the Sage CRM Web Services, complete the following steps:

  1. Enable and configure Web Services. For more information, see:
  2. View the WSDL file and prepare and submit your request to Web Services.
    For more information, see Using the WSDL file.
  3. Receive and process the response from Web Services.

The SOAP Web Services API is only available in certain editions of Sage CRM. For more information, see the Sage CRM Editions Comparison Guide.