Studio DRM Token API v2 (Standalone)

The Studio DRM token has several purposes:

• Authentication: Studio DRM tokens have a limited lifetime and are designed to be single use. Please contact your JWP Solutions Engineer if you do not know what the Studio DRM token's TTL is for your account.
• Delivering the DRM policy to the license server: The playback rights of a user for individual pieces of content can be set dynamically. A single user may be granted different rights on a single piece of content depending on business requirements.
• Signed authorization: Authorization is signed on the client's behalf for JW Player to issue a DRM license to the holder of the token. Issuing a Studio DRM token to a player will grant that player access to the DRM-protected content.

Studio DRM tokens should be generated using the Studio DRM Token API. The request to the Studio DRM Token API should be made from a server-side application. Then, the Studio DRM token should be delivered to the client side for use by a player in a license request.

All requests made to this API require a Studio DRM Standalone API key set as the header x-api-key. If you do not know or have not been given your Studio DRM Standalone API key please contact JW Player Support.

🚧

Studio DRM tokens must not be generated on the client side.

Studio DRM token structure

The Studio DRM token is comprised of five components each separated by the pipe character (ASCII code 124):

• Client name
• Token generation time in ISO 8601 (yyyy-MM-ddThh:mm:ss) format
• Token version
• Encrypted DRM policy
• Signed hash

🚧

Studio DRM tokens are designed to be single use and have a one-to-one relationship with the license request. Each license request must use a new Studio DRM token.

Studio DRM tokens expire with a TTL set to around 30 seconds. The time a token will expire is calculated by the time the token is generated plus the TTL. The time a token was generated is displayed in the token. This is a separate time to the DRM policy times set in the encrypted DRM policy.

Generate a Studio DRM token

https://token.vudrm.tech/v2/generate
Generates a Studio DRM token

🚧

All mentions of api_key in this article refer to the Studio DRM Standalone API key.

Request

curl -X POST https://token.vudrm.tech/v2/generate \
     -H 'x-api-key: {api_key}' \
     -d '{"clientName": "<client>","policy": {"content_id":"<content-id>","rental_duration_seconds":"<duration>","offline":false}}'

Body Parameters

policy object

This table is not an exhaustive list. If you require the use of more advanced settings, please contact JW Player Support.

policy.fairplay

The values of this object override values in the general section of the policy and apply only to FairPlay.

{
    "fairplay" : {
        "rental_duration_seconds":2700,
        "license_type":"r"
    }
}

policy.geo_restrictions

{
    "geo_restrictions": {
        "metro_code_whitelist":[501],
        "country_code_whitelist":["usa"],
        "block_vpn_and_tor":true
    }
}

policy.playready

The values of this object override values in the general section of the policy and apply only to PlayReady.

policy.session

You can set information about the current DRM session in the policy used by the Studio DRM token. Using the current DRM session information, JW Player makes a request to an API of your choosing.

If the API returns a 200 status, a valid license will be served back. Otherwise, no license will be returned.

{
    "session": {
        "id": "someID",
        "url": "https://www.some-url.com/valid",
        "method": "GET",
        "headers": { "myHeader": "someValue", "myOtherHeader": "someOtherValue" }
    }
}

GET https://some-url.com/valid?sessionId=abc123 

curl -X POST \
  https://some-url.com/valid \
  -H 'API_KEY: {api_key}' \
  -d '{"sessionId": "abcd1234"}'

policy.widevine

The values of this object override values in the general section of the policy and apply only to Widevine.

📘

To automatically renew online Widevine licenses, can_renew must be set to true and rental_duration_seconds must be set for a duration greater than 1800 seconds.

With "can_renew": true, Widevine attempts to renew the license every 1800 seconds. Setting the rental_duration_seconds to greater than 1800 seconds prevents any license gaps.

Additional policy Object Considerations

The following table explains several parameter combinations to consider when creating a policy.