1. 接口描述
接口请求域名： drm.tencentcloudapi.com 。
本接口用来设置fairplay方案所需的私钥、私钥密钥、ask等信息。
如需使用fairplay方案，请务必先设置私钥。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AddFairPlayPem。 |
| Version | 是 | String | 公共参数，本接口取值：2018-11-15。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Pem | 是 | String | 加密后的fairplay方案申请时使用的私钥。 请使用腾讯云DRM 提供的公钥，使用rsa加密算法，PKCS1填充方式对私钥文件中的字段进行加密，并对加密结果进行base64编码。 |
| Ask | 是 | String | 加密后的fairplay方案申请返回的ask数据。 请使用腾讯云DRM 提供的公钥，使用rsa加密算法，PKCS1填充方式对Ask字符串进行加密，并对加密结果进行base64编码。 |
| PemDecryptKey | 否 | String | 私钥的解密密钥。 openssl在生成rsa时，可能会需要设置加密密钥，请记住设置的密钥。 请使用腾讯云DRM 提供的公钥，使用rsa加密算法，PKCS1填充方式对解密密钥进行加密，并对加密结果进行base64编码。 |
| BailorId | 否 | Integer | 委托者Id,适用于托管自身证书的客户。普通客户无需填该字段。 |
| Priority | 否 | Integer | 私钥的优先级，优先级数值越高，优先级越高。 该值可以不传，后台将自动分配一个优先级。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FairPlayPemId | Integer | 设置私钥后，后台返回的pem id，用来唯一标识一个私钥。 注意：此字段可能返回 null，表示取不到有效值。 |
| Priority | Integer | 私钥的优先级，优先级数值越高，优先级越高。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置Fairplay方案所需的私钥、ASK
输入示例
https://drm.tencentcloudapi.com/?Action=AddFairPlayPem
&Pem=ENEcI2pZnZPi/x+wZNXaNDyfdw/hMoTpYDSNuaGV0gw1NhEE2zMMDdPhFcE0EbRx6sBKcTNfqTSa/M7cB6RAWcv0Ic/96UBSMjzIKvvViMUnozEoce3ySm6pS/KHxa32Xtmd/3aKxYgeHl1MIG03CdGIotV6rXo/V727gXTVQcg=&Ask=ISS0DkPgq41Q7ca7/QWEUlAkrsCsRsxrN2y0R8kJN4jIepYnaflfNXiIsb/iR0Rrg24DofcKJx2Y5NgYUMVaxPtVyiTR5mtoo5HB9cvEyEgje9tKMlP1WyBoKRMFlYy32jqTZZeUW1uLpXdLhn2yyPOfw9s0XlsdKVKs5Hsxqnc=
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03",
"FairPlayPemId": 1234,
"Priority": 2
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.PemIdNotExist | pem id 不存在。 |
| FailedOperation.PemNumTooMuch | 系统中存在的私钥数超过两个。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| UnknownParameter | 未知参数错误。 |