RPI v7 Realtime API updates

Overview

RPI v7.x introduces a different deployment of Realtime API (v2). These changes affect anyone who is running Realtime in RPI v6 and are upgrading to RPI v7. This page outlines the differences between the Realtime endpoints deployed with the different RPI versions.

The v1 API endpoints continue to exist in RPI v7.x deployments, however we strongly recommend upgrading to the v2 API endpoints.

In RPI v7.x, the paths for all of the endpoints have changed, and versioning has been introduced.
Some endpoints that were deprecated have been removed, and Client ID has been removed from some paths and bodies.
In addition to Realtime being deployed in a container in v7.x, there are changes to the path endpoints as well as some of the parameters and bodies of the call. The table below provides a high-level overview of the changes.
If you are currently using the WebClient, then you will need to make sure that you transition to the latest version of the WebClient to ensure that the changes to the endpoint paths, parameters, and bodies are reflected in the WebClient calls.

When upgrading from RPI v6 to v7, you should review your Realtime deployment and be sure to factor in the changes to the deployment, endpoints, and WebClient to ensure a clean transition to the latest version of RPI and Realtime.

Reference table of API changes

Status description	Label
Not available in v2 Endpoints	NOT AVAILABLE IN V2 ENDPOINTS
Path Change - Body Same or No Body	BODY SAME OR NO BODY
Path Change - Body Change	BODY CHANGE
Path Change - Parameters Change & Potential Body Changes	PARAM CHANGE & POTENTIAL BODY CHANGE

We’ve shortened the endpoints in the table below for improved readability of the table. For example, /api/v2/account/register is shortened to v2/account/register in the table.

Tag	Method	V6 endpoint (`/api/`…)	V7 endpoint (v2) (`/api/`…)	Summary
Account	`POST`	`Account/Register`	`v2/account/register`	BODY SAME OR NO BODY Creates a new OAuth user.
Account	`GET`	`Account/Users`	`v2/account/users`	BODY SAME OR NO BODY Gets the list of OAuth users.
Account	`DELETE`	`Account/Users/{userName}`	`v2/account/users/{userName}`	BODY SAME OR NO BODY Deletes an OAuth user.
Account	`GET`	`Account/Users/{userName}/Roles`	`v2/account/users/{userName}/roles`	BODY SAME OR NO BODY Gets the list of roles assigned to an OAuth user.
Account	`POST`	`Account/Users/{userName}/Roles`	`v2/account/users/{userName}/roles`	BODY SAME OR NO BODY Changes the roles for an OAuth user.
Account	`POST`	`Account/Users/ResetPassword`	`v2/account/users/reset-password`	BODY SAME OR NO BODY Changes the password for an OAuth user.
Account	`POST`	`Account/ChangePassword`	`v2/account/change-password`	BODY SAME OR NO BODY Changes the password for an OAuth user (requires old password).
Cache	`POST`	`Cache/Visit`	`v2/cache/visit`	BODY CHANGE Registers a Realtime visit for a visitor profile (creates a Realtime visitor profile for new visitors).
Cache	`DELETE`	`Cache/Profile`	`v2/cache/profile`	BODY SAME OR NO BODY Deletes a visitor profile from the Realtime cache.
Cache	`POST`	`Cache/{clientID}/Parameters`	`v2/cache/parameters`	BODY CHANGE Adds Realtime parameters to a visitor profile.
Cache	`POST`	`Cache/{clientID}/{visitorID}/` `Parameters`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Adds Realtime parameters to a visitor profile.
Cache	`POST`	`Cache/CachedAttributes`	`v2/cache/cached-attributes`	BODY CHANGE Triggers a Cached Attribute List lookup for a visitor profile.
Cache	`POST`	`Cache/{clientID}/{pagePublishID}/` `Goals`	`v2/cache/{pagePublishID}/goals`	BODY SAME OR NO BODY Changes the winning index for a published Goal Smart Asset.
Cache	`POST`	`Cache/Visitors/{clientID}/Views/` `{viewName}`	`v2/cache/visitors/views/` `{viewName}`	BODY SAME OR NO BODY Gets the Visitor View for a visitor profile.
Configuration	`GET`	`Configuration/AppSettings`	`v2/configuration/app-settings`	BODY SAME OR NO BODY Gets the Realtime API AppSettings configuration.
Configuration	`GET`	`Configuration/GeolocationSettings`	`v2/configuration/geolocation-settings`	BODY SAME OR NO BODY Gets the Realtime API GeolocationSettings configuration.
Configuration	`GET`	`Configuration/Queues`	`v2/configuration/queues`	BODY SAME OR NO BODY Gets the Realtime API Queues configuration.
Configuration	`GET`	`Configuration/QueueListener` `Configuration`	`v2/configuration/queue-listener-configuration`	BODY SAME OR NO BODY Gets the Realtime API QueueListenerConfiguration configuration.
Configuration	`GET`	`Configuration/IdentitySettings`	`v2/configuration/identity-settings`	BODY SAME OR NO BODY Gets the Realtime API IdentitySettings configuration.
Configuration	`GET`	`Configuration/CacheSettings`	`v2/configuration/cache-settings`	BODY SAME OR NO BODY Gets the Realtime API CacheSettings configuration.
Configuration	`GET`	`Configuration/Plugins`	`v2/configuration/plugins`	BODY SAME OR NO BODY Gets the Realtime API Plugins configuration.
Configuration	`GET`	`Configuration/VisitorViews`	`v2/configuration/visitor-views`	BODY SAME OR NO BODY Gets the Realtime API VisitorViews configuration.
Decision	`GET`	`Decisions/Preview/{fileID}/` `{visitorID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS
Decision	`POST`	`Decisions/Serialized/{clientID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Requests a Realtime decision for a specific visitor using the serialized decision content. The visitor identity is determined based on the supplied keys.
Decision	`POST`	`Decisions/{clientID}/{contentID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Requests a Realtime decision for a specific visitor and content, returning multiple qualifying results. The visitor identity is determined based on the supplied keys.
Decision	`POST`	`Decisions/{clientID}/{contentID}/` `{visitorID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Requests a Realtime decision for a specific visitor and content, returning multiple qualifying results.
Decision	`POST`	`Decisions/Contexts/{clientID}/` `{contextName}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Requests multiple decision results for a list of contexts or Smart Asset Publish IDs. The visitor identity is determined based on the supplied keys.
Decision	`POST`	`Decisions/{clientID}/SmartAssets`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Requests multiple decision results for a given context. The visitor identity is determined based on the supplied keys.
Decision	`POST`	`Decisions/Contexts/{clientID}/` `{contextName}/{visitorID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Requests multiple decision results for a given context.
Decision	`GET`	`Decisions/Images/{clientID}/` `{publishedContentID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS
Decision	`GET`	`Decisions/LinkTrack/{clientID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS
Events	`POST`	`Events`	`v2/events`	BODY CHANGE Creates a Realtime event for a visitor profile.
Events	`POST`	`Events/Batch/{visitorID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Creates multiple Realtime events for a visitor profile.
Events	`POST`	`Events/Visitor`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Creates a Realtime event for a visitor profile (creates a Realtime visitor profile for new visitors).
Events	`POST`	`Events/Queue`	`v2/events/queue`	BODY SAME OR NO BODY Creates a Queue Listener event.
Events	`POST`	`Events/Queue/{visitorID}`	`v2/events/queue/{visitorID}`	BODY SAME OR NO BODY Creates a Queue Listener event for a visitor profile.
Events	`POST`	`Events/Queue/Batch`	`v2/events/queue/batch`	BODY SAME OR NO BODY Creates multiple Queue Listener events for a visitor profile.
Form	`POST`	`FormData`	`v2/form-data`	PARAM CHANGE & POTENTIAL BODY CHANGE Processes a Web Form submission.
Recommendations	`GET`	`Recommendations/{visitorID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Gets a product recommendation for a visitor profile.
Recommendations	`GET`	`Recommendations`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Gets a product recommendation for a lookup hash.
SmartAsset	`GET`	`SmartAssets/Preview/{fileID}/` `{visitorID}`	`v2/smart-assets/preview/{fileID}/{visitorID}`	BODY SAME OR NO BODY Gets decision previews for Smart Assets (unpublished).
SmartAsset	`POST`	`SmartAssets/Serialized/{clientID}`	`v2/smart-assets/serialized`	PARAM CHANGE & POTENTIAL BODY CHANGE Gets decision results for a serialized Smart Assets.
SmartAsset	`POST`	`SmartAssets/{clientID}/Results`	`v2/smart-assets/results`	PARAM CHANGE & POTENTIAL BODY CHANGE Gets decision results for Smart Assets.
SmartAsset	`GET`	`SmartAssets/Images/{clientID}/` `{publishedContentID}`	`v2/smart-assets/images/{publishedContentID}`	PARAM CHANGE & POTENTIAL BODY CHANGE Image redirection endpoint for Smart Assets containing Image Assets.
SmartAsset	`GET`	`SmartAssets/LinkTrack/{clientID}`	`v2/smart-assets/link-track`	PARAM CHANGE & POTENTIAL BODY CHANGE Link redirection endpoint for Smart Assets containing Link Assets.
System	`GET`	`Status/version`	`v2/system/version`	BODY SAME OR NO BODY Get version information for Realtime API and Realtime Agent.
System	`GET`	`Status`	`v2/system/status`	BODY SAME OR NO BODY Gets status information for Realtime API and its dependencies (Realtime Agent, queues and caches).
System	`GET`	`Status/{clientID}`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Gets status information for Realtime API and its dependencies (Realtime Agent, queues, caches and databases).
System	`GET`	`Status/Cache/{cacheName}`	`v2/system/status/cache/{cacheName}`	BODY SAME OR NO BODY Gets status information for Realtime API cache.
System	`POST`	`Status/config/push-appsettings-file`	N/A	NOT AVAILABLE IN V2 ENDPOINTS Creates an `realtime_InstanceInfo` entry in the Pulse database for the current instance of Realtime API.