Skip to content

docs: Document FairPlay support in DRM license API #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PReshma-tp merged 3 commits into from
Feb 25, 2026
Merged

docs: Document FairPlay support in DRM license API #91

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c870799
document FairPlay support in DRM license API
PReshma-tp Feb 25, 2026
104610f
update
PReshma-tp Feb 25, 2026
7a575ea
Apply suggestion from gemini code assist
PReshma-tp Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 75 additions & 21 deletions docs/server-api/drm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,23 @@ To play DRM protected videos, your player should request DRM licence from our UR
This API requires [access_token](../video-embedding/authentication.md) in query param for authentication.

```bash
POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_license/?access_token={{access_token}}
POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_license/?access_token={{access_token}}&drm_type={{drm_type}}
```
**Fields**

| Name | Type | Description | Required |
| -------------- | ------ | ------------------------------------------------------ | -------- |
| player_payload | string | Player license key message encoded into base64 String. | Yes |
| widevine | json | See the Widevine table below for available fields. | No |
**Query Parameters**


**Widevine**
| Name | Type | Description | Default |
| ---------- | ------ | ------------------------------------------------- | ---------- |
| `drm_type` | string | The type of DRM. Options: `widevine`, `fairplay`. | `widevine` |

**Request Body**

| Name | Type | Description | Required |
| ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------- | -------- |
| `player_payload` | string | For **Widevine**, this is the key message. For **FairPlay**, this is the Server Playback Context (SPC) message. This **must be encoded in base64** to be sent within the JSON body. | Yes |
| `widevine` | object | Additional configurations for Widevine. See the Widevine table below. | No |

**Widevine Configuration Fields**

+---------------------------------------------------+------------------------------------------------------+
| **Name** | **Description** |
Expand Down Expand Up @@ -68,24 +74,72 @@ POST: https://app.tpstreams.com/api/v1/<organization_id>/assets/<asset_id>/drm_l
| | (not recommended for rental content). |
+---------------------------------------------------+------------------------------------------------------+

**Sample Payload:**
**Sample Payloads**

<details>
<summary>Widevine Sample</summary>

```json
{
"player_payload": keyMessageInbase64,
"widevine": {
"content_key_specs": [
{'track_type': 'SD', 'security_level': 1, 'required_output_protection': {'hdcp': 'HDCP_V1'}},
{'track_type': 'HD', 'security_level': 1, 'required_output_protection': {'hdcp': 'HDCP_V1'}},
{'track_type': 'UHD1', 'security_level': 1, 'required_output_protection': {'hdcp': 'HDCP_V1'}},
{'track_type': 'UHD2', 'security_level': 1, 'required_output_protection': {'hdcp': 'HDCP_V1'}},
{'track_type': 'AUDIO', 'security_level': 1, 'required_output_protection': {'hdcp': 'HDCP_V1'}}
],
"license_duration": 3600,
}
"player_payload": "<base64_encoded_key_message>",
"widevine": {
"content_key_specs": [
{
"track_type": "SD",
"security_level": 1,
"required_output_protection": { "hdcp": "HDCP_V1" }
},
{
"track_type": "HD",
"security_level": 1,
"required_output_protection": { "hdcp": "HDCP_V1" }
},
{
"track_type": "UHD1",
"security_level": 1,
"required_output_protection": { "hdcp": "HDCP_V1" }
},
{
"track_type": "UHD2",
"security_level": 1,
"required_output_protection": { "hdcp": "HDCP_V1" }
},
{
"track_type": "AUDIO",
"security_level": 1,
"required_output_protection": { "hdcp": "HDCP_V1" }
}
],
"license_duration": 3600
}
}
```

</details>

<details>
<summary>FairPlay Sample</summary>

```json
{
"player_payload": "<base64_encoded_spc_data>"
}
```

</details>

---

### Response

The API returns the raw binary license which should be passed directly to the browser's CDM or the player SDK.

- **Status Code**: `200 OK`
- **Content-Type**: `application/octet-stream`
- **Body**: Raw binary data (Widevine License or FairPlay Content Key Context).

---

**Security Considerations:**

The recommendation is to invoke the DRM license endpoint on the server, rather than on the client. This precaution is taken because passing the License configuration and calling it from the client could expose configurations to users.
The recommendation is to invoke the DRM license endpoint on the server, rather than on the client. This precaution is taken because passing the License configuration and calling it from the client could expose configurations to users.