Bootstrap API
The Bootstrap API is typically the URL that is sent to the client/video playback APIs. For options and parameters that can be configured, refer to the Bootstrap API parameters.
Send a command to the Manifest Server
-
Send an
HTTP GET
request for a bootstrap URL constructed using the following pattern:code language-none https://{manifest-server:port}/auditude/variant/ {PublisherAssetID}/{Content URL (base64)}.[m3u8 or mpd] ?{query parameters}
-
File extension Defined.
.m3u8
if the target manifest are HLS,.mpd
if the target manifests are in the DASH. -
PublisherAssetID Required. Publisher’s unique ID for the specific content.
-
Content URL Required. URL of the content M3U8 file, Base64 encoded to be safe within the manifest server URL. The content URL must point to a variant M3U8 file, even if there is only one bit rate stream.
-
Query parameters These constitute the most varied part of the request. They tell the manifest server which sort of client is making the request and what it wants the manifest server to do.
For example:
code language-none https://manifest.auditude.com/auditude/variant/ {publisherAssetID}/{Content URL (base64)}.[m3u8 or mpd]? u={Asset ID}&z={zone}&_sid_=0&pttrackingmode=simple &pttrackingversion=v2&live=false
HTTP vs. HTTPS requests
The manifest server creates URLs using the same HTTP protocol of the client’s request. If a player makes a non-secure HTTP (http) request, the manifest server returns manifest URLs and Auditude tracking URLs with the http protocol. If a player makes a secure HTTP (https) connection, manifest server, it returns manifest URLs and Auditude tracking URLs with the https protocol.
note note NOTE The manifest server cannot change the protocol (HTTP or HTTPS) of 3rd-party tracking beacons. You must contact the content and 3rd-party ad providers to have them configure the desired protocols. Segments URL protocols can be changed, however, by default, use the same protocols defined in the target manifests. -
Bootstrap API parameters
Query parameters tell the manifest server what sort of client sent the request and what that client wants the manifest server to do. Some are required and some have specific acceptable formats or values.
The complete URL consists of the base URL followed by a question mark, then parameterName=value
arguments separated by ampersands. For example, Base URL?name1=value1&name2=value2& . . .&name n=value n
.
The manifest server recognizes the following parameters. All querystring
parameters are passed to the ad server.
Possible values:
true for live content
false for vod content
omit for auto-detection
Possible values:
true to enable
omit to disable (default disabled)
Possible values:
numeric string in milliseconds.
omit to disable (default disabled)
Possible values:
numeric string 0-1800 (default 1800)
Possible values:
akamai, level3, llnw (limelight networks), comcast.
By default, Primetime Ad Insertion CDNs are used.
Possible values:
dpisimple, dpiscte35, elemental
For custom cue formats, contact your technical account representative for the value to use for your use case
omit to disable (default disabled)
Example: adfetch_fw, cdn_akm
Possible values:
akamai, llnw (limelight), ctl (centurylink) (default tokenization is disabled)
Possible values:
simple for client-side ad tracking
sstm for server-side ad tracking
simplesstm for hybrid client/server ad tracking (by default, no ad tracking is performed)
Note: The manifest server ignores all passed values. However, if you pass a null or empty string, the manifest server returns the M3U8
Client-Side Tracking
Possible values:
v1, v2, v3, or vmap
Client-Side Tracking
Possible values:
true or false (default false)
Note: The SCTE-35 data is returned in the JSON sidecar with the following combination of query parameter values:
ptcueformat=turner
Note: This parameter applies to Live/Linear HLS streams only
Possible values:
numeric float
(default: 3.0 - same as HLS specification)
Note: This parameter applies to Live/Linear HLS streams only
Possible values:
numeric float
(default: 3.0)