Conax - API details

1. Request description

1.1. Authentication

This API requires a basic authentication token.

A user name and password must be passed in the authorization HTTP request header with the request.

The authorization header is constructed as follows:

User name and password are combined into a string "username:password".
The resulting string is then encoded using base64.
The authorization method and a space, in other words "Basic " is put before the encoded string.

For example, if the user name Aladin and password sesam open is used, the header is formed as follows:

CODE

Authorization: Basic QWxhZGluOnNlc2FtIG9wZW4=

1.2. Request body

List of body parameters :

Element

Type

Description

Required

ContentId

xs:string

A unique identifier of the content

YES

ContentType

xs:string

Possible values :

LIVE
VOD

YES

DrmId

xs:string

Identification of DRM system and packaging

The content may be enabled for one or more DRM systems. This is enforced when requesting specific DRM systems.

If no DRM system is specified in the request :

DASH packaging data will be returned for all enabled DRM systems supporting CENC/MPEG-DASH.

Possible values :

PLAYREADY_SS
PLAYREADY_HLS
FAIRPLAY_HLS
PLAYREADY_CENC
WIDEVINE_CENC
CCA_CENC (PRM)
CCA_HLS (PRM)

Request example

XML

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://www.conax.com/ott/xsd/keyserver/v1">
   <soapenv:Header/>
   <soapenv:Body>
      <v1:GetDrmData>
         <v1:GetDrmDataRequest>           
            <v1:ContentId>50</v1:ContentId>           
            <v1:ContentType>VOD</v1:ContentType>                       
            <v1:DrmId>FAIRPLAY_HLS</v1:DrmId>
            <v1:DrmId>WIDEVINE_CENC</v1:DrmId>
            <v1:DrmId>PLAYREADY_CENC</v1:DrmId>
         </v1:GetDrmDataRequest>
      </v1:GetDrmData>
   </soapenv:Body>
</soapenv:Envelope>

2. Response description

The response contains a TransactionStatus element and a DrmData element containing the key and DRM headers for one or more DRM systems.

Element

Type

Description

Required

TransactionStatus

TransactionStatusType

A status that describes the outcome of the operation

YES

DrmData

xs:complexType

DRM Data Type

(zero or more)

The encryption key and DRM headers for one or more DRM systems

Omitted if the operation failed.

Response example

XML

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
	<soap:Body>
		<ns2:GetDrmDataResponse xmlns:ns2="http://www.conax.com/ott/xsd/keyserver/v1" xmlns="http://www.conax.com/cas/xsd/common-types/v1">
			<ns2:DrmDataResponse>
				<TransactionStatus>
					<StatusCode>OK</StatusCode>
				</TransactionStatus>
				<ns2:DrmData>
					<ns2:Key>Wx+F0u0EtDUQGIVtIREZVg==</ns2:Key>
					<ns2:KeyId>CGlnTo0tRBi6M6M10YPTMQ==</ns2:KeyId>
					<ns2:ContentRef>4363eb60-ac67-46d7-bca1-aa87c19bc372</ns2:ContentRef>
					<ns2:DrmHeaderData>
						<ns2:DrmId>FAIRPLAY_HLS</ns2:DrmId>
						<ns2:Header>skd://eyJMaWNlbnNlU2VydmVyVXJsIjoiaHR0cHM6Ly9jb25uZWN0LmNvbmF4LmNvbTo4MDk 3L2xpY2Vuc2UiLCJLZXlJZCI6IjA4Njk2NzRlLThkMmQtNDQxOC1iYTMzLWEzMzVkMTgzZDMzMS IsIkNvbnRlbnRSZWYiOiI0MzYzZWI2MC1hYzY3LTQ2ZDctYmNhMS1hYTg3YzE5YmMzNzIifQ==</ns2:Header>
						<ns2:IV>AAAAAAAAAAAAAAAAAAAAAA==</ns2:IV>
					</ns2:DrmHeaderData>
					<ns2:DrmHeaderData>
						<ns2:DrmId>WIDEVINE_CENC</ns2:DrmId>
						<ns2:Header>CAESEAhpZ06NLUQYujOjNdGD0zEaBUNvbmF4IiQ0MzYzZWI2MC1hYzY3LTQ2ZDctYmNhMS1hYTg3YzE5YmMzNzI=</ns2:Header>
						<ns2:DrmSystemId>edef8ba9-79d6-4ace-a3c8-27dcd51d21ed</ns2:DrmSystemId>
					</ns2:DrmHeaderData>
					<ns2:DrmHeaderData>
						<ns2:DrmId>PLAYREADY_CENC</ns2:DrmId>
						<ns2:Header>GAQAAAEAAQAOBDwAVwBSAE0ASABFAEEARABFAFIAIAB4AG0AbABuAHMAPQAiAGgAdAB0AHAAOgAvAC8AcwBjAGgA ZQBtAGEAcwAuAG0AaQBjAHIAbwBzAG8AZgB0AC4AYwBvAG0ALwBEAFIATQAvADIAMAAwADcALwAwADMALwBQAGwA YQB5AFIAZQBhAGQAeQBIAGUAYQBkAGUAcgAiACAAdgBlAHIAcwBpAG8AbgA9ACIANAAuADAALgAwAC4AMAAiAD4A PABEAEEAVABBAD4APABQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsARQBZAEwARQBOAD4AMQA2ADwALwBLAEUA WQBMAEUATgA+ADwAQQBMAEcASQBEAD4AQQBFAFMAQwBUAFIAPAAvAEEATABHAEkARAA+ADwALwBQAFIATwBUAEUA QwBUAEkATgBGAE8APgA8AEwAQQBfAFUAUgBMAD4AaAB0AHQAcABzADoALwAvAGMAbwBuAG4AZQBjAHQALgBjAG8A bgBhAHgALgBjAG8AbQA6ADgAMAAxADAALwBjAHgAcABsAGEAeQByAGUAYQBkAHkALwByAGkAZwBoAHQAcwBtAGEA bgBhAGcAZQByAC4AYQBzAG0AeAA8AC8ATABBAF8AVQBSAEwAPgA8AEwAVQBJAF8AVQBSAEwAPgBoAHQAdABwAHMA OgAvAC8AYwBvAG4AbgBlAGMAdAAuAGMAbwBuAGEAeAAuAGMAbwBtADoAOAAwADEAMAAvAGMAeABwAGwAYQB5AHIA ZQBhAGQAeQAvAHIAaQBnAGgAdABzAG0AYQBuAGEAZwBlAHIALgBhAHMAbQB4ADwALwBMAFUASQBfAFUAUgBMAD4A PABLAEkARAA+AFQAbQBkAHAAQwBDADIATgBHAEUAUwA2AE0ANgBNADEAMABZAFAAVABNAFEAPQA9ADwALwBLAEkA RAA+ADwAQwBVAFMAVABPAE0AQQBUAFQAUgBJAEIAVQBUAEUAUwAgAHgAbQBsAG4AcwA9ACIAIgA+ADwAQwBvAG4A dABlAG4AdABSAGUAZgA+ADQAMwA2ADMAZQBiADYAMAAtAGEAYwA2ADcALQA0ADYAZAA3AC0AYgBjAGEAMQAtAGEA YQA4ADcAYwAxADkAYgBjADMANwAyADwALwBDAG8AbgB0AGUAbgB0AFIAZQBmAD4APAAvAEMAVQBTAFQATwBNAEEA VABUAFIASQBCAFUAVABFAFMAPgA8AEMASABFAEMASwBTAFUATQA+AFMAQQBRAC8ATQBxAHIAZwByAEYAbwA9ADwA LwBDAEgARQBDAEsAUwBVAE0APgA8AC8ARABBAFQAQQA+ADwALwBXAFIATQBIAEUAQQBEAEUAUgA+AA==</ns2:Header>
						<ns2:DrmSystemId>9A04F079-9840-4286-AB92-E65BE0885F95</ns2:DrmSystemId>
						<ns2:LicenseServer>https://connect.conax.com:8010/cxplayready/rightsmanager.asmx</ns2:LicenseServer>
					</ns2:DrmHeaderData>
				</ns2:DrmData>
			</ns2:DrmDataResponse>
		</ns2:GetDrmDataResponse>
	</soap:Body>
</soap:Envelope>