Any authorised mobile app, website or API can post to the platform's Visitor API, and the platform can pass store and display context back to it. When a visitor scans the QR code on a connected display, the Store Code and Display ID of that display can be appended to a mobile site menu URL as tokens, so your app or third-party site knows where the visitor is.

Before you begin

Authenticate your app with the Visitor API

  1. In the left navigation, select Platform Admin, then under Enabled Features select API Authentication.
  2. Select Add New Platform and name it after the app or system you are connecting.
  3. Copy the secret and store it in the app's secure configuration — see Create API authentication credentials for an integration.
  4. In your app, send the feed as a POST to https://<your-platform-domain>/location-api/visitor/feed with the apikey header set to that secret. The body fields are in Use customer and decisioning data to personalise the store visit.

Pass the Store Code and Display ID to your app or site

  1. In Platform Admin, under Enabled Features, select Mobile Store Sites.
  2. Select the template assigned to your displays, for example Mobile App (DEFAULT).
  3. Select Add Menu Item, or select an existing menu item's URL.
  4. In the URL, select + Add Token and insert the Store Code and Display ID tokens where your app expects them as query parameters.
  5. Select Save Changes.
The footer of API Authentication shows Clear Visitor Data from Display after 2 minutes. Select its edit icon to change how long a visitor's context stays attached to a display after they scan.

Verify it worked

Scan a connected display's QR code and open the menu item. The URL your app or site receives contains that display's Store Code and Display ID. A feed your app posts with the same uuid and display_id triggers a matching campaign on that display.

Next step

Connect AI models and providers