REST APIs

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

Note

You can only use the Sitecore Personalize REST APIs if your organization accesses Sitecore Personalize using the Sitecore Cloud Portal. For more information, contact your Sitecore representative.

Overview

Sitecore Personalize exposes resources through REST APIs, which provide a flexible method of supplying various applications with data formatted in a standard way. Sitecore Personalize REST APIs support JSON resource representations.

At a fundamental level, you can use the REST APIs to provide synchronous access to Sitecore Personalize. 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 Personalize 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

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

You can use the following REST APIs as an alternative to using the Sitecore Personalize application:

Connection REST API - to connect to external systems.
Decision model and Decision model variant REST APIs - to work with decisioning.
Flow definition REST API - to work with web, interactive, and triggered experiments and experiences.
Template REST API - to work with web templates and decision templates.

Sitecore Personalize 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,