Integration Overview

Integration with the platform has two discrete components:

Steps that need occur only once to set up the initial integration
Steps that occur repeatedly as part of ongoing business

Initial Set Up

Initial integration with the platform includes:

Receiving the unique retailer id
Generating the retail access key
Integrating the retailer inventory feed
Configuring the positions available on category and search pages

Receiving the retailer id

Each retailer in the Streaem platform has a unique integer identifier that is sent in all requests to the Streaem platform.
This will be issued by the Streaem support team.
This identifier can be re-requested at any time but cannot be changed.

Generating the access key

All requests to the Streaem platform must be correctly signed using the algorithm described later.
This requires an encryption key that can be generated through a token management page in the Streaem user interface.
Retailers can use this page to list key ids, request a new key and disable an existing key.
Streaem recommends frequent key rotation and to support this a maximum of two keys can be live at any point in time.

Feed integration

The Streaem platform requires integration with the retailer inventory feed to derive data in four areas:

Available products
The category hierarchy
The mapping from brand identifier to the corresponding advertiser in the Streaem platform
Product availability/stock level (though see later for an alternative mechanism for this)

Configuring positions

The Streaem platform decides which products to be shown in sponsored product slots on both category and search result pages.
Before sending any auction requests the nature of the pages must be configured in the platform.
This will include:

Defining how many positions that can show sponsored product are on each page
Defining how many product slots are in each of these positions
Defining floor prices

The Streaem platform supports different layouts across the three platform types:

Desktop web
Mobile web
In-app

For example, the desktop web search result page may have two rows each with 4 product slots while the in-app page has only one area with 3 product slots.
When the Streaem platform is invoked it will return a maximum of 8 winning products for desktop web requests and 3 for in-app.

This page configuration can be changed at any time as business and e-commerce platform changes demand; the Streaem platform will shape the auction results to the latest platform configuration.

📘
Important:
The Streaem platform decides which products to be shown in sponsored product slots on both category and search result pages.