Introduction to Sage CRM Web Services
Sage CRM’s Web Service API (application programming interface) enables developers to manipulate CRM records remotely with SOAP (Simple Object Access Protocol) over HTTP using XML (Extensible Markup Language). It is possible to access a CRM server or a hosted system from a specified client machine (typically another server) in order to read, create, update, or delete records for each exposed entity, for example, companies, people, opportunities, or cases.
Web Services User Setup
Before Web Services can be accessed, a user needs to be set up for Web Services on the server.
To set up a user for Web Services:
Select Administration | Users | Users, and find the user who needs to access Web Services.
Select the hypertext link for the user, and select Change action.
Scroll down to the Security panel, and set the Allow Web Service Access field to True.
- Select Save.
Note: Only one web service user can log on with a given ID at any given time. If a user tries to log on as another application, an error is displayed, informing the user to first log out. However, it is possible to log on to the desktop or from a device with the same ID while a web service application is running.
Specifying Web Services Configuration Settings
There are a number of Web Services configuration settings that you need to be aware of.
To access Web Service configuration settings:
Select Administration | System | Web Services.
On the Web Service Settings page, select Change action.
Make the changes required as per the following table. For more information, see the attachment.
|Enable Web Services
||Set to Yes to enable the Web Services functionality. Set to No to disable Web Services.
|Send And Return All Dates And Times In Universal Times
||When this is selected, all dates coming from the server are set to universal time. Also, all dates coming to the web server are offset from universal time.
|Force Web Service Log On
||If the connection between the web service client and the service is unexpectedly broken, that client remains logged on to the server hosting the service. This means that a new instance of the client will be blocked from logging on to the server. However, if you set the Force Webservice Log On setting to Yes, the old instance of the client is automatically logged out when a new instance attempts to log on. By forcing new logons, this field prevents users from being locked out of a web service after a failed connection or unsuccessful logoff.