Request SSAI-enabled stream
Overview
This document explains the schema and parameters of the HLS live manifest URL used for server-side ad insertion. The URL contains placeholders that must be replaced with the appropriate values for each request.
HLS live manifest URL
The manifest URL and its parameters use the following schema:
https://$DOMAIN/hls/$CHAN_ID/master.m3u8?api-key=$API_KEY&ifa=$IFA&context=$CONTEXT&player_width=$WIDTH&player_height=$HEIGHT®s[gdpr]=$GDPR&user[consent]=$CONSENT
The dollar-uppercase strings in the manifest URL are placeholders that must be replaced with the appropriate values from the following table.
| Parameter | Description |
|---|---|
| $DOMAIN | The domain serving the manifest. |
| $CHAN_ID | The channel ID as configured in the channel management tool. |
| $API_KEY | The API key as configured in the channel management tool. |
| $IFA | A unique identifier for each client, sent to the SSP. |
| $CONTEXT | The context of the request, either web or app. |
| $WIDTH | The resolution width in pixels. |
| $HEIGHT | The resolution height in pixels. |
| $GDPR |
A boolean, indicating if the GDPR legislation applies.
|
| $CONSENT |
The user’s consent regarding personal data processing.
A full IAB consent string |
For more information, see the Server-to-server requests and SSAI configuration.