Functions

Boxever.browserShow(browserId, clientKey, callback, format)

The browserShow() function retrieves the guest reference from Sitecore Personalize.

The guest reference is in the customer.ref key of the parameter that is passed to the callback function.

Parameters

Parameter	Type	Description	Note
`browserId`	string	The browser ID.	Set the value to `Boxever.browser_id`.
`clientKey`	string	The client key.	Set the value to `Boxever.client_key`. Or, to bypass authentication, set the value to `0`.
`callback`	function	This callback function handles the response.	The guest reference is in the `customer.ref` key of the parameter that is passed to the callback function.
`format`	string	The format of the response.	Set the value to `"json"`. Other formats are not supported.

Return value

undefined

Example

In the callback function, using the customer.ref key, log the guest reference to the console:

Boxever.browserShow(
    Boxever.browser_id,
    Boxever.client_key,
    response => console.log(response.customer.ref),
    "json"
);

// f7aabbca-1c1b-4fc2-be72-3e16294a4f03

If you have suggestions for improving this article, let us know!