Server-Side Panorama ID API
OVERVIEW
The Server-Side Panorama ID API is a Real-time server-side API endpoint designed to return the assigned Panorama ID for the device ID sent into the request. This page will outline the technical details of the REST endpoint and provide a few examples.
HTTP POST Endpoint
JSON Object Details
Request JSON Details
Key | Data Type | Required? | Description |
id | String | Yes | Identifier being passed. |
id_type | String | Yes | Type of ID being passed. Currently, only Mobile IDs of IDFA and GAID (iOS and Android respectively) are allowed. |
ip_address | String | Yes | IP address in IPv4 or IPv6 format. |
user_agent | String | Yes | Client user-agent string. |
client_id | Integer | Yes | Static value assigned to you by Lotame. |
consent | Object | Yes | Details for this object are in the table below. |
Consent Object JSON Details
Key | Data Type | Required? | Description |
consent.gdpr_applies | Boolean | Yes, unless using lotame_consent value below | True or False to indicate whether the originating consumer interaction is subject to enforcement of the GDPR. |
consent.gdpr_consent | String | Yes, unless using lotame_consent value below | Consent string as specified in the TCFv2 spec |
consent.lotame_consent | Boolean | Yes, unless using GDPR values above | True or False to indicate whether you have obtained consent |
Response JSON Details
Key | Data Type | Description |
pano_id | String | Lotame Panorama ID. |
expiry_ts | Long | Timestamp in ms relative to the epoch. Clients should not request this same ID until after this expiration time. |
errors | Array of Integers |
May contain zero-to-all of the following error codes (with the description after the hyphen): * 110 - Invalid JSON in the request body |
no_consent | String | One of the following strings (with the description after the hyphen): * NO_CORE_CONSENT - Processing disallowed due no consent via Lotame Consent |
Example JSON Objects
Request Example
{
"id": "aebe52e7-03ee-455a-b3c4-e57283966239",
"id_type": "GAID",
"ip_address": "192.168.0.20",
"client_id": 123,
"consent": {
"gdpr_applies": true,
"gdpr_consent": "CPoB4-bPoB4-bABAMBFRACCgAAAAAAAAAAYgAAAAAAAA"
}
}
Response Examples
Success
{
"pano_id": "aa24ca9e5712f0411ac79902056616d539383860cb22fe55608b9920d7e6c659",
"expiry_ts": 1678476158619
}
Failure
{
"expiry_ts": 1678476158619,
"errors": [111],
"no_consent": "TCF"
}