Developer center

2.1   Request Parameters

Note: The customerAuthenticator parameter can also be passed in an HTTP header (i.e. ‘customerAuthenticator: 863255912,62981eb9f1ef49d5893d71bee6181735’)

2.2   Example Queries

Production:

https://api.{prod_domain}/cmiapi/getrecord?customerAuthenticator=553,d31ab64f35724f69beb177f0c3d01e41a&type=ms3

Test:

https://api.test.expressplay.com/cmiapi/getrecord?customerAuthenticator=553,d31cd34f35724f69beb177f0c3d01e41a&type=bb

https://api.test.expressplay.com/cmiapi/getrecord?customerAuthenticator=553,d31cd34f35724f69beb177f0c3d01e41a&type=pr

2.3   HTTP Response

The response will be of Content-Type application/json.

2.4   JSON Contents

2.5   Events Fields for bb, ms3, fp and wv

2.6   Events Fields for PlayReady

2.7   Event Error Codes

3.1   Request Parameters

Note: The customerAuthenticator parameter can also be passed in an HTTP header (i.e. ‘customerAuthenticator: 863255912,62981eb9f1ef49d5893d71bee6181735’)

3.2   Example Queries

Production:

https://api.{prod_domain}/cmiapi/getrecordbytime?customerAuthenticator=553,d31ab64f35724f69beb177f0c3d01e41a&type=ms3

Test:

https://api.test.expressplay.com/cmiapi/getrecordbytime?customerAuthenticator=553,d31cd34f35724f69beb177f0c3d01e41a&type=bb

3.3   HTTP Response

The response will be of Content-Type application/json.
Refer to ‘Events Fields for bb, ms3, fp, wv’ and ‘Events fields for PlayReady’ tables for the events returned in the events list.

3.4   JSON Contents

4.1   Request Parameters

Note: The customerAuthenticator parameter can also be passed in an HTTP header (i.e. ‘customerAuthenticator: 863255912,62981eb9f1ef49d5893d71bee6181735’)

4.2   Example Queries

Production:

https://api.{prod_domain}/cmiapi/getarchivedlog?customerAuthenticator=553,d31ab64f35724f69beb177f0c3d01e41a&date=2017-01-21

Test:

https://api.test.expressplay.com/cmiapi/getarchivedlog?customerAuthenticator=553,d31cd34f35724f69beb177f0c3d01e41a&date=2017-01-21

4.3   HTTP Response

The response will be of Content-Type application/javascript and compressed with gzip.
Refer to ‘Events Fields for bb, ms3, fp, wv’ and ‘Events fields for PlayReady’ tables for the events returned in the events list.

5.1   Token Parameters

5.2   License Parameters

5.3   Token Restriction Parameters

Note about kid: For example, if the hash of string is: 0123456789ABCDEF0123456789ABCDEF01234567, the truncated SHA1 hash is 0123456789ABCDEF0123456789ABCDEF (first 32 characters)

Note: The contentURL parameter is treated as a template, with template parameters
replaced with appropriate values. The only currently defined template parameter
is s:authenticator, which will be replaced by the value of the authenticator
parameter specified in the token generation request. A sample contentURL might
be http://www.bok.net/music/get-token?auth= {s:authenticator}&cid=8967F56D

Note: For MS3, contentId is not mandatory when kid/kek are provided in the token request. The MS3 service computes the contentId as the implicit content ID per Marlin spec, as “urn:marlin:kid:” + KID,. If your content IDs differ from this pattern, as for instance when using Marlin BBTS content IDs, the contentId parameter has to be specified explicitly.

5.4   Correlation Parameters

5.5   Example Queries

Production:

https://ms3-gen.{prod_domain}/hms/ms3/token?customerAuthenticator=790,0e8c78e70c574ddd82731f77b889c1b0&contentId.0=1234123412341234&contentKey.0=12311232123312341235123612371238&contentURL=www.test1234.com/test/test/test.mp4

https://ms3-gen.{prod_domain}/hms/ms3/token?customerAuthenticator=790,0e8c78e70c574ddd82731f77b889c1b0&contentId.0=1234123412341234&kek=01112233445566778899aabbccddeeff&kid.0=519139C2BD60DBE70F8C15714BF2A00B&contentURL=www.test1234.com/test/test/test.mp4

Test:

https://ms3-gen.test.expressplay.com/hms/ms3/token?customerAuthenticator=790,0e8c78e70c574ddd82731f77b889c1b0&contentId.0=1234123412341234&contentKey.0=12311232123312341235123612371238&contentURL=www.test1234.com/test/test/test.mp4

https://ms3-gen.test.expressplay.com/hms/ms3/token?customerAuthenticator=790,0e8c78e70c574ddd82731f77b889c1b0&contentId.0=1234123412341234&kek=01112233445566778899aabbccddeeff&kid.0=519139C2BD60DBE70F8C15714BF2A00BcontentURL=www.test1234.com/test/test/test.mp4

5.6   HTTP Response

Note: Depending on the value of the errorFormat parameter, the response will either be of
Content-Type text/html or application/json. In the case of text/html, the message, formatted
as HTML will provide an error code and error message in human-readable format. In the case
of application/json, see JSON Errors for the representation of the error code and error
message.

5.7   Event Error Codes

6.1   Token Parameters

6.2   Registration Parameters

6.3   Token Restriction Parameters

6.4   Correlation Parameters

6.5   HTTP Response

Note: Depending on the value of the errorFormat parameter, the response will either be of
Content-Type text/html or application/json. In the case of text/html, the message, formatted
as HTML will provide an error code and error message in human-readable format. In the case
of application/json, see JSON Errors for the representation of the error code and error
message.

6.6   Event Error Codes

7.1   Token Parameters

7.2   License Parameters

7.3   Token Restriction Parameters

7.4   Correlation Parameters

7.5   outputControlFlags:

7.6   outputControlValue:

7.7   HTTP Response

Note about kid: For example, if the hash of string is: 0123456789ABCDEF0123456789ABCDEF01234567, the truncated SHA1 hash is 0123456789ABCDEF0123456789ABCDEF (first 32 characters)

Note: Depending on the value of the errorFormat parameter, the response will either be of
Content-Type text/html or application/json. In the case of text/html, the message, formatted
as HTML will provide an error code and error message in human-readable format. Error codes will be negative integer values.

7.8   Event Error Codes

8.1   Token Parameters

8.2   Deregistration Parameters

8.3   Token Restriction Parameters

8.4   Correlation Parameters

8.5   HTTP Response

Note: Depending on the value of the errorFormat parameter, the response will either be of
Content-Type text/html or application/json. In the case of text/html, the message, formatted
as HTML will provide an error code and error message in human-readable format. In the case
of application/json, see JSON Errors for the representation of the error code and error
message.

8.6   Event Error Codes

9.1   Token Parameters

9.2   License Parameters

9.3   Token Restriction Parameters

9.4   Correlation Parameters

9.5   HTTP Response

The response of the ExpressPlay REST API for PlayReady License Token Request is a JSON payload that contains two fields:
“licenseAcquisitionUrl” and “token”. Refer to the following link for more details:

https://www.expressplay.com/developer/playready-apps/

Note about kid: For example, if the hash of string is: 0123456789ABCDEF0123456789ABCDEF01234567, the truncated SHA1 hash is 0123456789ABCDEF0123456789ABCDEF (first 32 characters)

Note: Depending on the value of the errorFormat parameter, the response will either be of
Content-Type text/html or application/json. In the case of text/html, the message, formatted
as HTML will provide an error code and error message in human-readable format.Error codes will be negative integer values.

Note about PlayReady license redemption: When redeeming the PlayReady license using the generated token, it’s mandatory to specify the ‘content-type: text/xml’ HTTP header

9.6   Event Error Codes

10.1   Token Parameters

10.2   License Parameters

10.3   Token Restriction Parameters

10.4   Correlation Parameters

10.5   HTTP Response

The response of the ExpressPlay REST API for FairPlay License Token Request is of type text/uri-list containing the
license acquisition url + license token as a ExpressPlayToken query parameter.

For example:

https://fp-gen.{prod_domain}/hms/fp/rights/?ExpressPlayToken=AQAAAJJ2Y0MAAABQbyvnJ6KgEg_w-2yZmU-MsjTEZ3f7UkhUcFhDFAvdonzBkRGQU-xe1G-DMbel5-BVH_PozovdWhKZx0_SXRokfh9-FERmBl6OEfGfPqMI1eO1PqRkx59Q2q1s2cFNrqfml8Y3RQ

Note: Depending on the value of the errorFormat parameter, the response will either be of
Content-Type text/html or application/json. In the case of text/html, the message, formatted
as HTML will provide an error code and error message in human-readable format. Error codes will be negative integer values.

Note about FairPlay license redemption: When redeeming the FairPlay license using the generated token, it’s mandatory to specify ‘content-type: application/octet-stream’ HTTP header.

10.6   Event Error Codes

11.1   Token Parameters

11.2   License Parameters

Note about licenseDuration:

1. Playback will stop licenseDuration seconds after beginning of playback.
2. To allow playback to be stopped/resumed for an unlimited amount of time, omit licenseDuration (it will default to infinite). Otherwise specify the amount of time during which end-users should be able to enjoy the stream

12 Universal License Token Request

Deprecation Notice

The Universal Token API will be deprecated on June 30th 2020, after this date only essential bug fixes will be made to the API. The API will no longer be supported after April 1, 2021.

Purpose

Requests a token that can be redeemed by a customer for a Marlin (BB, MS3), Fairplay, Widevine or a Playready license.

To redeem a token for a Widevine license, the following header must be set, otherwise the server will not issue a correct license.
Request header during token redemption: “utoken-drm : wv”.

URLs

Production:

https://ut-gen.{prod_domain}/hms/ut/token

Test:

https://ut-gen.test.expressplay.com/hms/ut/token

Method

POST (with a json body containing parameters for all the DRMs)

{
   "expirationTime": "2017-10-20T12:01:10Z",
   "generalFlags": "00000000",
   "kek": "",
   "ek": [],
   "kids": ["b366360da82e9c6e0b0984002a362c00"],
   "contentKeys": ["a0a1a2a3a4a5a6a7a8a9aaabacadae00"],
   "contentIds": ["urn:marlin:kid:b366360da82e9c6e0b0984002a362c00"],
   "cookie": "",
   "marlinbb": {
       "bbActionTokenType": "1",
       "bbDeviceId": "",
       "bbRightsType": "BuyToOwn",
       "bbOutputControlFlags": "",
       "bbOutputControlValue": "",
       "bbOutputControlObligation": ["SecureContentPath,SecurityClass,dXJuOm15b3RoZXJjb250ZW50aWQ=.1.AAAAAAg=="],
       "bbOutputControlOverride": ["SecureContentPath,SecurityClass,dXJuOm15b3RoZXJjb250ZW50aWQ=.1.AAAAAAg=="],
       "bbRentalPeriodEndTime": ""
   },
   "marlinms3": {
       "ms3ControlFlags" : "00",
       "ms3DeviceId": "",
       "ms3OutputControlFlags": "00000000",
       "ms3OutputControlValue" : "00000000",
       "ms3ExtensionData": ["wudo,false,AAAAAA=="]
   },
   "fp": {
       "fpDeviceId": "",
       "fpRentalDuration":
        3600,
        "fpIv": "000102030405060708090a0b0c0d0e0f",
       
   },
   "pr": {
       "prDeviceId": "",
       "prMinCertSecurityLevel": 2000,
       "prRightsType": "Rental",
       "prRentalPeriodEnd": "+3600",
       "prRentalPlayDuration": 3600,
       "prAnalogVideoOPL": 100,
       "prCompressedDigitalAudioOPL": 100,
       "prCompressedDigitalVideoOPL": 100,
       "prUncompressedDigitalAudioOPL": 100,
       "prUncompressedDigitalVideoOPL": 100,
       "prUnknownOutputBehavior": "Allow",
       
       "prAppRestriction": ""
  },
  "wv": {
       "wvContentId": "",
       "wvDeviceId": "",
       "wvTrackTypes": [1],
       "wvSecurityLevels": [1],
       "wvHdcpOutputControls": [1],
       "wvCgmsFlagsOutputControls": [1],
       "wvDisableAnalogOutputs": [0],
       "wvHdcpSrmRules": [0],
       "wvLicenseDuration": 36000,
       "wvPlaybackDuration": 23654656,
       
  }
}

12.7   Event Error Codes

13   A/B Manifest Generation

Purpose

Generate a content manifest with a watermark derived from manifests of A/B rendering of the content (See ExpressPlay watermarking SDK for details)

URLs

HLS

https://wm.service.expressplay.com/wm/manifest/hlsca

DASH

https://wm.service.expressplay.com/wm/manifest/dashca

Method

POST

14   JSON Errors

API responses have the following structure for error data. Error codes will be negative integer values.

{
  "valid": false,
   "events": [],
   "error": {
     "message": <error_message>,
     "code": <error_code>
   }
 }

15   General Error Codes

The following error codes may appear across the service API.