Welcome to the SAP Hybris Cloud for Customer CRM Element

Element Details

Base URL

The Cloud Element Base URL for all API calls is https://api.cloud-elements.com/elements/api-v2.

HTTP requests to the REST API are protected with HTTP Basic authentication with your Organization and User secret and an Element token. We use many standard HTTP features, like HTTP verbs, understood by most HTTP clients. JSON is returned in all responses from the API, including errors. The APIs have predictable, straightforward URLs and use HTTP response codes to indicate API errors.

Authenticating with Cloud Elements

To authenticate with Cloud Elements, you need to know your Organization Secret and User Secret. When making some calls, you also need to know the Element Token.

When you create an account with us, we assign you an Organization Secret and a User Secret. An Organization is a customer of Cloud Elements (/organizations). The User and Organization secrets represent your account with Cloud Elements.

To find your Organization and User Secret open the profile menu.

When you create a new connection to an endpoint, you will receive an Element token. After you create an instance, Cloud Elements automatically refreshes the token behind the scenes so that you won't need to connect your application again.

To find your Element token:

    GET /instances/<INSTANCE_ID>

An Element token and a User secret are required to execute one of our Hub API calls (e.g. /hubs/documents/files or /hubs/crm/contacts). For more information about Hubs, see the Hub API docs in the navigation area.

Pass tokens and secrets as basic HTTP Header values.

• To make a Platform or API call, include the following in the header:

  Authorization: User <INSERT_USER_SECRET>, Organization <INSERT_USER_SECRET>
  

• To make a Hub API call, include the following in the header:

  Authorization: User <INSERT_USER_SECRET>, Organization <INSERT_USER_SECRET>, Element <INSERT_ELEMENT_TOKEN>
  

Error Codes

Errors are never fun. To save you time we took a list of error codes from our service providers and normalized them. If a response returns a message that includes a specific detail about the method call, we send our normalized error code along with any additional data included in the body of the message. Below is a sample message from a service provider that would be included with our normalized error code.

{
   "message": "Failed to upload file. File with the same name already exists. Change the name of the file you're uploading or set the overwrite query parameter to true.",
   "requestId": "53dbca9430045c016b46566c",
   "providerMessage": "Item with the same name already exists"
}

We provide the following normalized error codes:

Get started by setting up the endpoint.