POST api/Harmonic
The V1 implementation of the Harmonic CPIX protocol. This supports a single key per request and utilizes the V1 Key Override algorithm. Multi-key and key rotation are not supported. Using the V2 endpoint is recommended.
Request Information
URI Parameters
None.
Body Parameters
None.
Request Formats
application/cpix+xml
Sample:
<?xml version="1.0"?> <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" contentId="integration_test"> <cpix:ContentKeyList> <cpix:ContentKey kid="af1ed63c-5784-460b-9e51-309dd47b7d9c"/> </cpix:ContentKeyList> <cpix:DRMSystemList> <cpix:DRMSystem systemId="9a04f079-9840-4286-ab92-e65be0885f95" kid="af1ed63c-5784-460b-9e51-309dd47b7d9c"/> <cpix:DRMSystem systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed" kid="af1ed63c-5784-460b-9e51-309dd47b7d9c"/> <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="af1ed63c-5784-460b-9e51-309dd47b7d9c"/> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_19d21813-874e-4804-8a56-1952722abeb5" index="213"/> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="af1ed63c-5784-460b-9e51-309dd47b7d9c"> <cpix:KeyPeriodFilter periodId="keyPeriod_19d21813-874e-4804-8a56-1952722abeb5"/> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX>
Response Information
Resource Description
None.
Status Codes
All HTTP status codes must be expected, but the following status codes are the most probable:
- OK (200) - CPIX response was successfully generated.
- BadRequest (400) - CPIX response generation failed due to invalid input.
Response Formats
application/cpix+xml
Sample:
<?xml version="1.0" encoding="utf-8"?> <cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" contentId="integration_test"> <cpix:ContentKeyList> <cpix:ContentKey kid="8a32a7c0-54dd-8e79-b67d-f3d5824efc07" explicitIV="tHrZGTSMD7DlPbCqhOaP6A=="> <cpix:Data> <pskc:Secret> <pskc:PlainValue>ZuBotmWM4Jajwwv88BjklA==</pskc:PlainValue> </pskc:Secret> </cpix:Data> </cpix:ContentKey> </cpix:ContentKeyList> <cpix:DRMSystemList> <cpix:DRMSystem systemId="9a04f079-9840-4286-ab92-e65be0885f95" kid="8a32a7c0-54dd-8e79-b67d-f3d5824efc07"> <cpix:PSSH>AAAB5HBzc2gAAAAAmgTweZhAQoarkuZb4IhflQAAAcTEAQAAAQABALoBPABXAFIATQBIAEUAQQBEAEUAUgAgAHgAbQBsAG4AcwA9ACIAaAB0AHQAcAA6AC8ALwBzAGMAaABlAG0AYQBzAC4AbQBpAGMAcgBvAHMAbwBmAHQALgBjAG8AbQAvAEQAUgBNAC8AMgAwADAANwAvADAAMwAvAFAAbABhAHkAUgBlAGEAZAB5AEgAZQBhAGQAZQByACIAIAB2AGUAcgBzAGkAbwBuAD0AIgA0AC4AMAAuADAALgAwACIAPgA8AEQAQQBUAEEAPgA8AFAAUgBPAFQARQBDAFQASQBOAEYATwA+ADwASwBFAFkATABFAE4APgAxADYAPAAvAEsARQBZAEwARQBOAD4APABBAEwARwBJAEQAPgBBAEUAUwBDAFQAUgA8AC8AQQBMAEcASQBEAD4APAAvAFAAUgBPAFQARQBDAFQASQBOAEYATwA+ADwASwBJAEQAPgB3AEsAYwB5AGkAdAAxAFUAZQBZADYAMgBmAGYAUABWAGcAawA3ADgAQgB3AD0APQA8AC8ASwBJAEQAPgA8AC8ARABBAFQAQQA+ADwALwBXAFIATQBIAEUAQQBEAEUAUgA+AA==</cpix:PSSH> <cpix:ContentProtectionData>PHBzc2ggeG1sbnM9InVybjptcGVnOmNlbmM6MjAxMyI+QUFBQjVIQnpjMmdBQUFBQW1nVHdlWmhBUW9hcmt1WmI0SWhmbFFBQUFjVEVBUUFBQVFBQkFMb0JQQUJYQUZJQVRRQklBRVVBUVFCRUFFVUFVZ0FnQUhnQWJRQnNBRzRBY3dBOUFDSUFhQUIwQUhRQWNBQTZBQzhBTHdCekFHTUFhQUJsQUcwQVlRQnpBQzRBYlFCcEFHTUFjZ0J2QUhNQWJ3Qm1BSFFBTGdCakFHOEFiUUF2QUVRQVVnQk5BQzhBTWdBd0FEQUFOd0F2QURBQU13QXZBRkFBYkFCaEFIa0FVZ0JsQUdFQVpBQjVBRWdBWlFCaEFHUUFaUUJ5QUNJQUlBQjJBR1VBY2dCekFHa0Fid0J1QUQwQUlnQTBBQzRBTUFBdUFEQUFMZ0F3QUNJQVBnQThBRVFBUVFCVUFFRUFQZ0E4QUZBQVVnQlBBRlFBUlFCREFGUUFTUUJPQUVZQVR3QStBRHdBU3dCRkFGa0FUQUJGQUU0QVBnQXhBRFlBUEFBdkFFc0FSUUJaQUV3QVJRQk9BRDRBUEFCQkFFd0FSd0JKQUVRQVBnQkJBRVVBVXdCREFGUUFVZ0E4QUM4QVFRQk1BRWNBU1FCRUFENEFQQUF2QUZBQVVnQlBBRlFBUlFCREFGUUFTUUJPQUVZQVR3QStBRHdBU3dCSkFFUUFQZ0IzQUVzQVl3QjVBR2tBZEFBeEFGVUFaUUJaQURZQU1nQm1BR1lBVUFCV0FHY0Fhd0EzQURnQVFnQjNBRDBBUFFBOEFDOEFTd0JKQUVRQVBnQThBQzhBUkFCQkFGUUFRUUErQUR3QUx3QlhBRklBVFFCSUFFVUFRUUJFQUVVQVVnQStBQT09PC9wc3NoPjxwcm8geG1sbnM9InVybjptaWNyb3NvZnQ6cGxheXJlYWR5Ij54QUVBQUFFQUFRQzZBVHdBVndCU0FFMEFTQUJGQUVFQVJBQkZBRklBSUFCNEFHMEFiQUJ1QUhNQVBRQWlBR2dBZEFCMEFIQUFPZ0F2QUM4QWN3QmpBR2dBWlFCdEFHRUFjd0F1QUcwQWFRQmpBSElBYndCekFHOEFaZ0IwQUM0QVl3QnZBRzBBTHdCRUFGSUFUUUF2QURJQU1BQXdBRGNBTHdBd0FETUFMd0JRQUd3QVlRQjVBRklBWlFCaEFHUUFlUUJJQUdVQVlRQmtBR1VBY2dBaUFDQUFkZ0JsQUhJQWN3QnBBRzhBYmdBOUFDSUFOQUF1QURBQUxnQXdBQzRBTUFBaUFENEFQQUJFQUVFQVZBQkJBRDRBUEFCUUFGSUFUd0JVQUVVQVF3QlVBRWtBVGdCR0FFOEFQZ0E4QUVzQVJRQlpBRXdBUlFCT0FENEFNUUEyQUR3QUx3QkxBRVVBV1FCTUFFVUFUZ0ErQUR3QVFRQk1BRWNBU1FCRUFENEFRUUJGQUZNQVF3QlVBRklBUEFBdkFFRUFUQUJIQUVrQVJBQStBRHdBTHdCUUFGSUFUd0JVQUVVQVF3QlVBRWtBVGdCR0FFOEFQZ0E4QUVzQVNRQkVBRDRBZHdCTEFHTUFlUUJwQUhRQU1RQlZBR1VBV1FBMkFESUFaZ0JtQUZBQVZnQm5BR3NBTndBNEFFSUFkd0E5QUQwQVBBQXZBRXNBU1FCRUFENEFQQUF2QUVRQVFRQlVBRUVBUGdBOEFDOEFWd0JTQUUwQVNBQkZBRUVBUkFCRkFGSUFQZ0E9PC9wcm8+</cpix:ContentProtectionData> <cpix:SmoothStreamingProtectionHeaderData>xAEAAAEAAQC6ATwAVwBSAE0ASABFAEEARABFAFIAIAB4AG0AbABuAHMAPQAiAGgAdAB0AHAAOgAvAC8AcwBjAGgAZQBtAGEAcwAuAG0AaQBjAHIAbwBzAG8AZgB0AC4AYwBvAG0ALwBEAFIATQAvADIAMAAwADcALwAwADMALwBQAGwAYQB5AFIAZQBhAGQAeQBIAGUAYQBkAGUAcgAiACAAdgBlAHIAcwBpAG8AbgA9ACIANAAuADAALgAwAC4AMAAiAD4APABEAEEAVABBAD4APABQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsARQBZAEwARQBOAD4AMQA2ADwALwBLAEUAWQBMAEUATgA+ADwAQQBMAEcASQBEAD4AQQBFAFMAQwBUAFIAPAAvAEEATABHAEkARAA+ADwALwBQAFIATwBUAEUAQwBUAEkATgBGAE8APgA8AEsASQBEAD4AdwBLAGMAeQBpAHQAMQBVAGUAWQA2ADIAZgBmAFAAVgBnAGsANwA4AEIAdwA9AD0APAAvAEsASQBEAD4APAAvAEQAQQBUAEEAPgA8AC8AVwBSAE0ASABFAEEARABFAFIAPgA=</cpix:SmoothStreamingProtectionHeaderData> </cpix:DRMSystem> <cpix:DRMSystem systemId="edef8ba9-79d6-4ace-a3c8-27dcd51d21ed" kid="8a32a7c0-54dd-8e79-b67d-f3d5824efc07"> <cpix:PSSH>AAAAOHBzc2gAAAAA7e+LqXnWSs6jyCfc1R0h7QAAABgSEIoyp8BU3Y55tn3z1YJO/AdI49yVmwY=</cpix:PSSH> <cpix:ContentProtectionData>PHBzc2ggeG1sbnM9InVybjptcGVnOmNlbmM6MjAxMyI+QUFBQU9IQnpjMmdBQUFBQTdlK0xxWG5XU3M2anlDZmMxUjBoN1FBQUFCZ1NFSW95cDhCVTNZNTV0bjN6MVlKTy9BZEk0OXlWbXdZPTwvcHNzaD4=</cpix:ContentProtectionData> </cpix:DRMSystem> <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="8a32a7c0-54dd-8e79-b67d-f3d5824efc07"> <cpix:HLSSignalingData playlist="master">I0VYVC1YLVNFU1NJT04tS0VZOk1FVEhPRD1TQU1QTEUtQUVTLFVSST0ic2tkOi8vOGEzMmE3YzAtNTRkZC04ZTc5LWI2N2QtZjNkNTgyNGVmYzA3OkI0N0FEOTE5MzQ4QzBGQjBFNTNEQjBBQTg0RTY4RkU4IixLRVlGT1JNQVQ9ImNvbS5hcHBsZS5zdHJlYW1pbmdrZXlkZWxpdmVyeSIsS0VZRk9STUFUVkVSU0lPTlM9IjEi</cpix:HLSSignalingData> <cpix:HLSSignalingData playlist="media">I0VYVC1YLUtFWTpNRVRIT0Q9U0FNUExFLUFFUyxVUkk9InNrZDovLzhhMzJhN2MwLTU0ZGQtOGU3OS1iNjdkLWYzZDU4MjRlZmMwNzpCNDdBRDkxOTM0OEMwRkIwRTUzREIwQUE4NEU2OEZFOCIsS0VZRk9STUFUPSJjb20uYXBwbGUuc3RyZWFtaW5na2V5ZGVsaXZlcnkiLEtFWUZPUk1BVFZFUlNJT05TPSIxIg==</cpix:HLSSignalingData> </cpix:DRMSystem> </cpix:DRMSystemList> <cpix:ContentKeyPeriodList> <cpix:ContentKeyPeriod id="keyPeriod_19d21813-874e-4804-8a56-1952722abeb5" index="213" /> </cpix:ContentKeyPeriodList> <cpix:ContentKeyUsageRuleList> <cpix:ContentKeyUsageRule kid="8a32a7c0-54dd-8e79-b67d-f3d5824efc07"> <cpix:KeyPeriodFilter periodId="keyPeriod_19d21813-874e-4804-8a56-1952722abeb5" /> </cpix:ContentKeyUsageRule> </cpix:ContentKeyUsageRuleList> </cpix:CPIX>