Thunder API – Creating Thunder Launch URLs

Overview

Thunder supports multiple methods for constructing launch URLs that can be used to open content in Thunder or ThunderCloud.

Launch URLs may be used directly or stored using the SaveUserUrlByGuid API to reduce URL length for large launch payloads that may exceed browser or application URL limits.

Thunder supports launch URLs for:

• XOS Plays
• GSIS Plays
• PFF Plays
• STATS Plays
• Thunder Edits

Launch URLs support both:

• ThunderCloud / Hub Pro
• Local Thunder installations

This article provides an overview of launch URL construction and links to the supported launch methods.

Prerequisites

Before creating a launch URL, ensure the following:

• Thunder, ThunderCloud, or Hub Pro is installed
• A valid authentication token is available
• Required endpoint parameters are known

Authentication

Thunder launch URLs require a valid authentication token in the <authentication> XML element.

For information on:

• Generating authentication tokens
• Vendor GUID requirements
• Token duration and expiration
• Authentication examples

See:

Thunder API – Authentication Token

Hub Pro Requirements

Hub Pro requires launch URLs to be submitted using the SaveUserUrlByGuid API.

Direct launch URLs are not supported.

After the launch URL has been saved, use the generated lookup URL to launch content in Hub Pro.

For information on creating lookup URLs, see:

Thunder API – SaveUserUrlByGuid

Supported Launch Methods

Thunder supports the following launch methods.

LaunchPlayer Request Types

LaunchPlayer request types use a simplified payload structure, where the <payload> element contains delimited identifiers.

For implementation details, see:

• Thunder API – LaunchPlayerByPlays / LaunchPlayerByEdits
• Thunder API – LaunchPlayerByGSIS / LaunchPlayerByGSISNonPro
• Thunder API – LaunchPlayer

MessageXML Request Types

MessageXML request types use structured XML payloads and support additional launch features such as:

• Angles
• OpenThunderPlaylist
• Team-scoped play resolution

For implementation details, see:

• Thunder API – XOSMessageXMLGet / XOSMessageXML
• Thunder API – MessageXMLGet / MessageXML
• Thunder API – PFFMessageXMLGet / PFFMessageXML

URL Format

Thunder launch URLs follow this general format.

Thunder (Secure)

https://localhost:8081/XOS/{Endpoint}?{XML Payload}

Thunder (Insecure)

http://localhost:8080/XOS/{Endpoint}?{XML Payload}

ThunderCloud / Hub Pro

thundercloud://XOS/{Endpoint}?{XML Payload}

Common XML Structure

Most Thunder launch methods follow a similar XML structure.

<root>
    <authentication token='TOKEN' vendor='VENDOR_GUID'/>
    <payload>
        ...
    </payload>
</root>

LaunchPlayer request types typically use delimited identifier strings inside <payload>.

MessageXML request types typically use structured XML elements such as <ContentType>, <League>, and <Plays>.

Related Articles

• Thunder API – Authentication Token
• Thunder API – SaveUserUrlByGuid
• Thunder API – LaunchPlayerByPlays / LaunchPlayerByEdits
• Thunder API – LaunchPlayerByGSIS / LaunchPlayerByGSISNonPro
• Thunder API – LaunchPlayer
• Thunder API – XOSMessageXMLGet / XOSMessageXML
• Thunder API – MessageXMLGet / MessageXML
• Thunder API – PFFMessageXMLGet / PFFMessageXML