JWjwplayer
SSAI

Explicit SSAI Session Initialization Endpoint

Initializes the SSAI session and returns a JSON with the URLs needed to stream content and track the session

If URL-signing is enabled, follow the instructions for creating a properly formed request.

For DRM-protected content, use the Single media, playback metadata endpoint and include the ad_config_id query parameter to request the SSAI version with DRM support.

post/v2/sites/{site_id}/media/{media_id}/ssai.{manifest_extension}

Request

  • Base URL
    https://cdn.jwplayer.com
  • URL
    https://cdn.jwplayer.com/v2/sites/{site_id}/media/{media_id}/ssai.{manifest_extension}
  • Auth
    none declared

Path parameters

site_idstring required

Property or site ID that owns a piece of media

media_idstring required

Eight-character, alphanumeric ID that uniquely identifies the media

This can be found on the video detail page in the dashboard.

manifest_extension'm3u8' | 'mpd' required

The file extension of the manifest

Possible values:

  • m3u8: HLS manifest
  • mpd: DASH manifest

Query parameters

ad_config_idstring required

Unique identifier of the ad config

schema'' | 'aws'

(Optional) Schema format for the requested SSAI media manifest

The schema query parameter is either omitted/empty or aws. When empty, successful JSON returns manifest_url and session_info. When schema=aws, the same values are returned as manifestUrl and trackingUrl.

Request body

reporting_modestring

Determines whether tracking beacons are sent by the client or the server

The selected value is appended as a query parameter to the session metadata URL returned in session_info, or in trackingUrl when schema=aws.

Possible values:

  • client: (Default) The player or client sends tracking beacons
  • server: The server sends tracking beacons
ads_paramsobject

Key-value pairs sent with the ad request

These pairs provide session-specific targeting information that the ad server uses to determine which ads are eligible to serve. Supported keys and values depend on your ad server and ad tag configuration.

Response

SSAI session started successfully. JSON containing the manifest URL and session info URL.

May include an optional warning when playback URLs are still returned but something did not match the ideal path.

OR

Changes

No recorded changes to this operation across all 1 revision of this API.