Key Acquisition API
The Key Acquisition API is used to acquire Content Keys for encryption.
The API is exposed by the Key Service.
OpenAPI Specification
The API reference in the OpenAPI format can be found at this location: https://key-server-management.axprod.net/api/help
Authorization
The authorization scheme depends on the endpoint.
Endpoints
The API exposes the following endpoints:
| Endpoint | Method | Protocol / Client | Input | Output |
|---|---|---|---|---|
| /WidevineProtectionInfo | POST | Widevine Common Encryption | WidevineRequest | WidevineResponse |
| /Speke | POST | AWS SPEKE v1 | CPIX | CPIX |
| /SpekeV2 | POST | AWS SPEKE v2 | CPIX | CPIX |
| /Harmonic/v2 | POST | Harmonic | CPIX | CPIX |
| /Anevia | GET | Anevia | CPIX Configuration | CPIX |
| /Broadpeak | GET | Broadpeak | CPIX | CPIX |
The endpoints below allow to configure some aspects of the respective endpoints above:
| Endpoint | Method |
|---|---|
| /HarmonicConfiguration | POST, GET |
| /WidevineProtectionInfoConfiguration | POST, GET |
| /WidevineProtectionInfoCredentials | POST, GET |
Errors
In case of an error, the service returns an HTTP status code following HTTP conventions.
Additionally, the service adds a human-readable explanation of the error in a custom HTTP header X-AxDRM-ErrorMessage.
If HTTP/1 is used the same error explanation is returned as HTTP ReasonPhrase.
We recommend that you rely on the X-AxDRM-ErrorMessage header because the ReasonPhrase is not supported by HTTP/2, and also some HTTP/1 client libraries do not support parsing the ReasonPhrase.
CORS clients, such as browsers, sometimes don’t have access to custom HTTP headers.
To enable such clients reading the informational headers, service adds Access-Control-Expose-Headers header to the response and explicitly enables reading of the "X-AxDrm-ErrorMessage" header.