Documentation Adobe Pass Adobe Pass Authentication

Obtain Short Media Token obtain-short-media-token

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Authentication

NOTE

The content on this page is provided for information purposes only. Usage of this API requires a current license from Adobe. No unauthorized use is permitted.

NOTE

REST API implementation is bounded by Throttling mechanism

REST API Endpoints clientless-endpoints

<REGGIE_FQDN>:

Production - api.auth.adobe.com
Staging - api.auth-staging.adobe.com

<SP_FQDN>:

Production - api.auth.adobe.com
Staging - api.auth-staging.adobe.com

Description description

Obtains Short Media Token.

Endpoint

Called
By

Input
Params

HTTP
Method

Response

HTTP
Response

<SP_FQDN>/api/v1/mediatoken

or

<SP_FQDN>/api/v1/tokens/media

For example:

<SP_FQDN>/api/v1/tokens/media

Streaming App

or

Programmer Service

1. requestor (Mandatory)
2. deviceId (Mandatory)
3. resource (Mandatory)
4. device_info/X-Device-Info (Mandatory)
5. deviceType
6. deviceUser (Deprecated)
7. appId (Deprecated)

GET

XML or JSON containing an Base64 encoded media token or error details if unsuccessful.

200 - Success
403 - No Success

Input Parameter

Description

requestor

The Programmer requestorId for which this operation is valid.

deviceId

The device id bytes.

resource

A string that contains a resourceId (or MRSS fragment), identifies the content requested by a user and is recognized by MVPD authorization endpoints.

device_info/

X-Device-Info

Streaming Device information.

Note: This MAY be passed device_info as a URL paramater, but due to the potential size of this paramater and limitations on the length of a GET URL, it SHOULD be passed as X-Device-Info n the http header.

See the full details in Passing Device and Connection Information.

deviceType

The device type (for example, Roku, PC).

If this parameter is set correctly, ESM offers metrics that are [broken down per device type]/(help/authentication/entitlement-service-monitoring-overview.md#clientless_device_type) when using Clientless, so that different types of analysis can be performed for. For example, Roku, AppleTV, and Xbox.

See Benefits of using clientless devicetype parameter

Note: the device_info will replace this parameter.

deviceUser

The device user identifier.

Note: If used, deviceUser should have the same values as in the Create Registration Code request.

appId

The application id/name.

Note: the device_info replaces this parameter. If used, appId should have the same values as in the Create Registration Code request.

Sample Response response

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <play>
        <expires>1348649569000</expires>
        <mvpdId>sampleMvpdId</mvpdId>
        <requestor>sampleRequestorId</requestor>
        <resource>sampleResourceId</resource>
        <serializedToken>PHNpZ25hdH[...]</serializedToken>
        <userId>sampleScrambledUserId</userId>
    </play>

JSON:

    {
        "resource": "sampleResourceId",
        "requestor": "sampleRequestorId",
        "expires": "1348649614000",
        "serializedToken": "PHNpZ25hdH[...]",
        "userId": "sampleScrambledUserId",
        "mvpdId": "sampleMvpdId"
    }

Media Verification Library compatibility

The field serializedToken from the “Obtain Short Media Token” call is a Base64 encoded token that can be verified against the Adobe Media Verification Library.

recommendation-more-help

3f5e655c-af63-48cc-9769-2b6803cc5f4b