The SAP Customer Data Cloud REST API is at the core of our platform. On top of the REST API, SAP Customer Data Cloud offers a set of Server Side SDKs that wrap around the API. The Server Side SDKs make it simple to integrate our service in server applications of various development environments.
Check out our Server Side SDKs documentation and find out if there is an SDK available for your preferred language. Otherwise, please continue with this guide and learn how to use our REST API directly.
The SAP Customer Data Cloud server-to-server API uses a REST-like interface. This means that the API method calls are made over the internet by sending HTTP GET or POST requests to the SAP Customer Data Cloud REST API server and the response is returned as JSON / JSONP. In some cases, the response may also be returned in XML, for backward compatibility. Nearly every software development environment provides methods for communicating over HTTP with a REST server.
Requests to our REST API should be signed for security purposes. The recommended best practice is to generate a bearer token for the signature. An alternative solution is to use application or user keys and a secret. In addition, the less recommended approach is to use the OAuth 2.0 standard or our proprietary authorization method. Use one of the following guides to start making REST API calls, using your preferred authorization method:
- (Recommended approach): Signing Requests to SAP Customer Data Cloud
- Using Gigya's REST API in compliance with OAuth 2.0
- Using Gigya's REST API with our proprietary authorization method
The REST API Reference provides specification to the various supported API methods.
Important: When using the REST API, all post data must be URL Encoded prior to being sent to the SAP Customer Data Cloud server, whether in the query or body of the request. If sending in the body, all parameters must be of content-type "www-form-urlencoded".
Handling Unknown Parameters
When calling an API, parameters that are not found in the method signature are ignored and discarded by default, allowing the request to be processed. In such a case, any parameters which have been ignored appear in the response, as follows:
To force an API call to fail with an error response when unknown parameters are encountered, pass the 'checkParams' control parameter with a value of 'true'.