personalizer.io Documentation

Help Page Home

POST v1/ImpersonateAuthentication

Get an impersonation Context ID.

Request Information

URI Parameters

None.

Body Parameters

Impersonation parameters.

ImpersonateAuthenticationParams
NameTypeDescriptionComments
ApiKey string

Impersonation-authorized Subscriber's API key obtained from LimeSpot.

Required

TargetWebsite string

The Website address of the subscriber for which an Impersonation Context ID is being requested.

Required

ContainerGuid globally unique identifier

Request Formats

application/json, text/json

Sample:
{
  "ApiKey": "6ce9a7c68580b27d20fc2138f9128f916ce9a7c68580b27d20fc2138f9128f91",
  "TargetWebsite": "castleblack.com"
}

Response Information

Resource Description

User Context ID.

AuthenticationResult
NameTypeDescriptionComments
ContextID string

ContextID to be used for making API calls. This must be used on REST HTTP Header value for X-Personalizer-Context-ID

UserID integer

LimeSpot UserID for the Context. This must be included on future authentication requests to ensure user history is incorporated in personalization

Response Formats

application/json, text/json

Sample:
{
  "ContextID": "VAz6MjWE90yadCfQdENsQA",
  "ContextExpirationTimeStamp": 0
}