POST marketing/v1/AdministratorAuthentication
Get administrative Context ID.
Request Information
URI Parameters
None.
Body Parameters
Administrator authentication parameters
AdministratorAuthenticationParamsName | Type | Description | Comments |
---|---|---|---|
ApiKey | string |
Subscriber's API key obtained from administration panel. |
Required |
AdministratorEmail | string |
Administrator's email address used to login to the administration panel. |
Required |
AdministratorPasswordHash | string |
MD5 hash of the Administrator's password used to login to the administration panel. |
Required |
LongLived | boolean |
Whether the context should be long-lived - Default: false |
Optional |
Request Formats
application/json, text/json
Sample:
{ "ApiKey": "cee4f350fba2dcd16d796aae120315e2f240ebe3f911f1862acbcc0dc76b14fb", "AdministratorEmail": "admin@example.com", "AdministratorPasswordHash": "827ccb0eea8a706c4c34a16891f84e7b" }
Response Information
Resource Description
Administrative Context ID.
AuthenticationResultName | Type | Description | Comments |
---|---|---|---|
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 |
|
UserSegmentGuids | Collection of globally unique identifier |
Response Formats
application/json, text/json
Sample:
{ "ContextID": "VAz6MjWE90yadCfQdENsQA", "ContextExpirationTimeStamp": 0 }