Thunder API – SaveUserUrlByGuid

Overview

Thunder supports the creation of shortened URLs for launching Thunder content. SaveUserUrlByGuid allows large Thunder launch URLs to be referenced by a GUID-based lookup URL. This is commonly used when launch URLs exceed browser, application, or integration URL length limits.

Important: Lookup URLs generated through SaveUserUrlByGuid do not extend authentication token lifetime. The saved launch URL still depends on the validity of the authentication token used when the URL was generated.

Thunder launch URLs can target either:

• ThunderCloud launches using thundercloud://
• Thunder local launches (secure) using https://localhost:8081/ 
• Thunder local launches (insecure) using http://localhost:8080/

The process involves:

1. Creating a Thunder launch URL
2. Submitting the URL to the SaveUserUrlByGuid API endpoint
3. Receiving a GUID response used to reference the saved URL

Prerequisites

Before creating a short URL, ensure the following:

• Access to the Thunder API
• Valid API authentication credentials
• A valid Thunder launch URL

Step 1 – Create the Launch URL

Construct the Thunder URL that will ultimately be launched.

Thunder supports multiple launch URL formats, including:

• LaunchPlayerByPlays
• XOSMessageXMLGet
• MessageXMLGet
• PFFMessageXMLGet

For details on supported launch methods, XML payload structures, optional parameters (Angles, OpenThunderPlaylist, ScoutedTeam), and endpoint formats, see:

Thunder API – Creating Thunder Launch URLs

Once the launch URL has been constructed, it can be submitted to the SaveUserUrlByGuid API endpoint to generate a reusable lookup URL.

Step 2 – Submit the URL to the API

Endpoint

POST https://tcssoservices.xosdigital.com/sso/RESTSSOServices.svc/SaveUserUrlByGuid

Authentication Headers

SaveUserUrlByGuid requires API authentication headers.

For required authentication headers and how to generate the authorization value, see:

Thunder API – Authentication Headers

Request Body

Submit the launch URL as JSON.

Example:

{
  "url": "https://localhost:8081/XOS/LaunchPlayerByPlays?plays=<root><authentication token='TOKEN' vendor='960c346c-89db-423a-aede-3011dd3d0b77'/></root>"
}

You may also submit a thundercloud:// URL.

Step 3 – Review the Response

If successful, the API returns an XML response containing a GUID.

Example Response:

<SaveUserUrlByGuidResponse xmlns="http://tempuri.org/">
    <SaveUserUrlByGuidResult>
        5e62d7d8-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    </SaveUserUrlByGuidResult>
</SaveUserUrlByGuidResponse>

The returned GUID represents the stored launch URL.

Step 4 – Use the Generated Short URL

The GUID returned from SaveUserUrlByGuid is used to reference the stored Thunder launch URL.

Option 1 – ThunderCloud Lookup

Example:

thunderCloud://XOS/LookupURL?URL=5e62d7d8-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Option 2 – Thunder Lookup

Example:

https://localhost:8081/XOS/LookupURL?URL=5e62d7d8-xxxx-xxxx-xxxx-xxxxxxxxxxxx

When accessed, the lookup URL resolves to the originally stored Thunder launch URL.

Note: The Thunder application must be running for localhost lookup URLs to function.

Example Workflow

ThunderCloud Example

1. Create a thundercloud:// launch URL
2. Submit the URL to SaveUserUrlByGuid
3. Receive the GUID response
4. Generate the lookup URL
5. Open the lookup URL to launch ThunderCloud

Thunder Example

1. Create a https://localhost:8081/ launch URL
2. Submit the URL to SaveUserUrlByGuid
3. Receive the GUID response
4. Generate the lookup URL
5. Open the lookup URL to launch the local Thunder application

Related Articles

• Thunder API – Authentication Headers
• Thunder API – Creating Thunder Launch URLs