Real-Time API

Configuring your DCN's real-time APIs

The Admin > Real-Time API section in the UI enables you to control who can access various low latency high-throughput real-time APIs associated with your DCN. The real-time APIs can be called from both a customer's server-side systems as well as from websites and applications by using the Optable SDKs. Some of the real-time APIs write data to your DCN, while others read and return data in real-time.

API Endpoints

The following real-time APIs are currently supported:

API	Description	Read or Write?
Identify	Links identifiers to a specified visitor ID.	Write
Profile	Attaches key/value traits and optionally links identifiers to a specified visitor ID. Also retrieves the specified visitor ID's audience memberships and extended identifiers, based on audiences enabled for real-time targeting and EIDs Switchboard configuration.	Write followed by Read
Witness	Records events associated with a specified visitor ID. Events can optionally contain associated event properties.	Write
Targeting	Retrieves the specified visitor ID's audience memberships and extended identifiers, based on audiences enabled for real-time targeting and EIDs Switchboard configuration.	Read
Tokenize	Calls the enabled resolvers from EIDs Switchboard with the specified HEM	Read
Resolve	Deprecated.	Read
Generate UID2 Token	Deprecated.	N/A

General Settings

The General tab lists all of the available real-time API endpoints and enables you to disable them as well as to toggle whether they can be called publicly without credentials or whether they can only be called with a valid user or service account credentials.

Client-Side Integrations

The default is that the API endpoints are enabled for public calling, which allows for them to be called by user browsers and mobile devices when Optable SDKs are deployed via SDK sources.

Server-Side Integrations

If you intend to call the APIs exclusively via a server-side integration, it's recommended to switch them to Private. You can then configure a service account and download revokable credentials that can be used to call the APIs.

Please ask your Optable support team representative for real-time API technical integration documentation.

Privacy Configuration

The Privacy Configuration tab enables you to activate API write and read restrictions. This enables you to seamlessly integrate the various privacy strings and settings emitted by your Consent Management Platform (CMP) or similar system, with the personal data processing activities in your Optable DCN.

When activating API privacy restrictions in the UI, you can specify the list of GDPR TCF purposes (please see IAB Tech Lab's Transparency and Consent Framework) for which you accept a legitimate interest or implied consent, or for which you require publisher-level consent, in order to perform either a write or read operation on your DCN.

Each of the real-time APIs performing a Read or Write (see above) optionally accepts privacy strings. Both the IAB Tech Lab's TCF and GPP strings are supported. If valid privacy parameters and strings are provided at the time of the API call, and/or if the caller's IP address resolves to a European Economic Area or a Canada/Quebec location, the APIs will accordingly require legitimate interest or implied consent, or publisher-level consent, for standard TCF purposes as configured and saved in the DCN's Admin > Real-Time API > Privacy Configuration UI.