REST APIs

REST APIs let you to retrieve, create, update, and delete data that is available in Sitecore CDP.

Overview

Sitecore CDP exposes resources through REST APIs, which provide 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 and write data
Online Data Capture (ODC)

When to use REST APIs

You can use the following REST APIs to perform CRUD operations on Sitecore CDP resources:

Guest REST API - to work with behavioral and transactional data about your guests.
Guest data extension REST API - to work with additional guest data of your choice.
Order, Order item, Order contact, and Order consumer REST APIs - to work with order-related data.
Order data extension and Order item data extension REST APIs - to work with additional order and order item data of your choice.
Audience export REST API - to access exported audience data for use outside Sitecore CDP.

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:

Resource attributes
Example requests
Example responses

Do you have some feedback for us?

If you have suggestions for improving this article,