Server side cookie management

Data collection / General / Server side cookie management / Server-side cookie management

These methods are only available for custom domains data collection (CDDC)

We provide several methods to manipulate your users’ server cookie.

These are GET HTTPS methods, to be carried out on your collection domain.

Retrieving the identifier

Return the user identifier

Endpoint

/cookie/get

Response

If the user has an identifier:

{
  "atid": "XXXX-XXXXX",
  "opt-out": false
}

If the user has opted out:

{
  "atid": "opt-out",
  "opt-out": true
}

If the user doesn’t have an identifier:

{
  "atid": null,
  "opt-out": null
}

Retrieving the status

Return the user status (opt-out)

Endpoint

/cookie/status

Response

If the user has opted out:

{
  "opt-out": true
}

If the user has not opted out:

{
  "opt-out": false
}

If the user doesn’t have an identifier:

{
  "opt-out": null
}

Switching to opt-out

Switch the user to opt-out

Endpoint

/cookie/optout

Response

{
  "atid": "opt-out",
  "opt-out": true
}

Switching to opt-in

Switch the user to opt-in

Endpoint

/cookie/optin

Response

{
  "atid": "XXXX-XXXXX", 
  "opt-out": false
}

Reset the user identifier

Create a new identifier for the user

Endpoint

/cookie/reset

Response

{
  "atid": "XXXX-XXXXX"
}

Delete the user identifier

Delete the user identifier (cookie)

Endpoint

/cookie/delete

Response

{
  "atid": null
}

Integration example

JavaScript object XMLHttpRequest

// Switching to opt-out
if (typeof XMLHttpRequest === 'function') {
    var xhr = new XMLHttpRequest();
    xhr.withCredentials = true; // Mandatory if the current page domain differs from CDDC
    xhr.open('GET', 'https://c.atinternet-solutions.com/cookie/optout', true);
    xhr.send();
}

Last update: 11/02/2020