Overview of Sitecore CDP REST APIs

Abstract

Provides an overview of the suite of Restful APIs that enable you to locate, create, update, retrieve, and delete data in Sitecore CDP (Data model 2.1).

Sitecore CDP has a suite of Restful APIs that make data management easier, faster, and more efficient. You use a REST client inside your application to communicate with the API, which allows you to locate, create, update, retrieve, and delete data.

Sitecore CDP exposes resources through the Interactive API, which provides a flexible method of supplying various applications with data formatted in a standard way. Sitecore CDP REST APIs support JSON resource representations.

At a fundamental level, you can use the REST APIs to provide synchronous access to Sitecore CDP. You can use the REST APIs to update data or to read the current state of data. REST APIs meet crucial integration requirements and allow data to be easily combined using mashups, while enabling you to extend on a set of base, REST services. For example, you might want to use your own custom attributes and make these available to Sitecore CDP resources. To do this, you can use a data extension resource, which is a schema-less JSON object that permits specific name/value pairs.

The following are characteristics of the REST APIs:

  • Support synchronous calls

  • Report processing errors

  • Support server-side requests

  • Session authentication

  • Read/write data

  • Online Data Capture (ODC)

When to use the Interactive API

An Integration Engineer uses the REST APIs as a prerequisite before a Marketer or Analyst sets up experiments that initiate dynamic content and offers.

Sitecore CDP enables you to deploy a suite of Interactive web services that expose the URL endpoints for retrieving and updating REST resources. The REST topics contain the following information:

  • Interactive APIs

  • Resource attributes

  • Example requests

  • Example responses

If you have interacted with REST before, you will already be familiar with the REST concepts. If you have not, we recommend that you use the Postman REST client for testing and familiarizing yourself with REST. The Postman REST client is free and is great for creating and sending HTTP requests. It also saves every request you have sent, so you can replay it later.