1. 接口描述
接口请求域名: ms.tencentcloudapi.com 。
该接口供渠道合作应用加固使用,接口调用有白名单用户限制,用于创建加固任务。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateEncryptInstance。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-08。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
PlatformType | 是 | Integer | 平台类型 1.android加固 2.ios源码混淆 3.sdk加固 4.applet小程序加固 示例值:1 |
OrderType | 是 | Integer | 订单采购类型 1-免费试用 2-按年收费 3-按次收费 示例值:1 |
EncryptOpType | 是 | Integer | 1-在线加固、 2-输出工具加固 示例值:1 |
ResourceId | 是 | String | 本次加固使用的资源id 示例值:svmsref_20241031_xxxxx |
AndroidAppInfo | 否 | AndroidAppInfo | 渠道合作android加固App信息 示例值:{ "AppMd5": "881ac0a49b3ae9967022217730cc0da8", "AppSize": 4743475, "AppUrl": "https://x.app.url", "AppName": "AppName", "AppPkgName": "com.tencnent.demo", "AppFileName": "demo.apk", "AppVersion": "7.8.1", "AppType": "apk" } |
AndroidPlan | 否 | AndroidPlan | 渠道合作android加固策略信息 示例值:{ "AppPkgName": "com.tencnent.demo", "AppType": "apk", "EncryptParam": "{"dex":{"enable":1,"antiprotect":1,"antirepack":1,"dexsig":1,"antimonitor":1,"ptrace":1}}" } |
AppletInfo | 否 | AppletInfo | 小程序加固信息 示例值:{ "AppletJsUrl": "http://xxxxxxxxxxxxxxxxxxx.zip", "AppletLevel": 1, "Name": "test.zip" } |
IOSInfo | 否 | IOSInfo | iOS混淆信息 示例值:{ "InfoPListUrl": "http://xxxxxxxxxxxxxxxxxxx.zip", "InfoPListSize": 100, "InfoPListMd5": "881ac0a49b3ae9967022217730cc0da8", "BuildType": "release" } |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResultId | String | 加固任务Id 示例值:ResultId-xxxxxx |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 iOS混淆示例
iOS混淆示例
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEncryptInstance
<公共请求参数>
{
"PlatformType": 2,
"OrderType": 1,
"EncryptOpType": 1,
"ResourceId": "xxxxxxxxxxxxxxxxxx",
"IOSInfo": {
"InfoPListUrl": "http://xxxxxxxxxxxxxxxxxxx.zip",
"InfoPListSize": 100,
"InfoPListMd5": "881ac0a49b3ae9967022217730cc0da8",
"BuildType": "release"
}
}
输出示例
{
"Response": {
"RequestId": "6ef4eac9-badc-40d9-9796-569741849f95",
"ResultId": "6ef4eac9-badc-40d9-9796-569741849f95"
}
}
示例2 小程序免费加固示例
小程序免费加固示例
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEncryptInstance
<公共请求参数>
{
"PlatformType": 4,
"OrderType": 1,
"EncryptOpType": 1,
"ResourceId": "xxxxxxxxxxxxxxxxxx",
"AppletInfo": {
"AppletJsUrl": "http://xxxxxxxxxxxxxxxxxxx.zip",
"AppletLevel": 1,
"Name": "test.zip"
}
}
输出示例
{
"Response": {
"RequestId": "6ef4eac9-badc-40d9-9796-569741849f95",
"ResultId": "6ef4eac9-badc-40d9-9796-569741849f95"
}
}
示例3 Android免费试用在线加固
成功创建任务示例
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEncryptInstance
<公共请求参数>
{
"PlatformType": 1,
"OrderType": 1,
"EncryptOpType": 1,
"ResourceId": "xxxxxxxxxxxxxxxxxx",
"AndroidAppInfo": {
"AppMd5": "881ac0a49b3ae9967022217730cc0da8",
"AppSize": 4743475,
"AppUrl": "https://x.app.url",
"AppName": "AppName",
"AppPkgName": "com.tencnent.demo",
"AppFileName": "demo.apk",
"AppVersion": "7.8.1",
"AppType": "apk"
},
"AndroidPlan": {
"AppPkgName": "com.tencnent.demo",
"AppType": "apk",
"EncryptParam": "{\"dex\":{\"enable\":1,\"antiprotect\":1,\"antirepack\":1,\"dexsig\":1,\"antimonitor\":1,\"ptrace\":1}}"
}
}
输出示例
{
"Response": {
"RequestId": "ecea8f16-273d-4e0d-b005-02ca6a6ed467",
"ResultId": "ecea8f16-273d-4e0d-b005-02ca6a6ed467"
}
}
示例4 Android按年收费加固输出工具
Android按年收费加固输出工具
输入示例
POST / HTTP/1.1
Host: ms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateEncryptInstance
<公共请求参数>
{
"PlatformType": 1,
"OrderType": 2,
"EncryptOpType": 2,
"ResourceId": "xxxxxxxxxxxxxxxxxx",
"AndroidAppInfo": {
"AppPkgName": "com.One.TEST",
"AppType": "apk"
},
"AndroidPlan": {
"AppPkgName": "com.One.TEST",
"AppType": "apk",
"EncryptParam": "{\n \"dex\": {\n \"enable\": 1,\n \"antiprotect\": 1,\n \"antirepack\": 1,\n \"dexsig\": 1,\n \"antimonitor\": 1,\n \"ptrace\": 1\n },\n \"so\": {\n \"enable\": 0,\n \"ver\": \"1.3.3\",\n \"file\": [\n \"\"\n ]\n },\n \"vmp\": {\n \"enable\": 0,\n \"ndkpath\": \"/xxx/android-ndk-r10e\",\n \"profile\": \"XXX\",\n \"mapping\": \"XXX\"\n },\n \"respro\": {\n \"assets\": {\n \"enable\": 0,\n \"file\": [\n \"assets/1.js\",\n \"assets/2.jpg\"\n ]\n },\n \"res\": {\n \"enable\": 0,\n \"file\": [\n \"res/layout/1.xml\",\n \"res/layout/2.xml\"\n ]\n }\n }\n}"
}
}
输出示例
{
"Response": {
"RequestId": "0f869fd0-0fd0-44bd-95fc-06a15b50aa61",
"ResultId": "0f869fd0-0fd0-44bd-95fc-06a15b50aa61"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.InvalidAuthorization | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.AndroidAppMd5Error | Android在线加固任务,入参字段AppMd5必输。 |
InvalidParameterValue.AndroidAppPkgNameError | Android应用包名必输,请求参数中的AppPkgName值要相等。 |
InvalidParameterValue.AndroidAppPkgNameListError | AppPkgNameList字段检查不通过,必输字段,值可为单个包年或多个包名时。值为多个包名时,包名需用逗号隔开,其数量不能超过10个。 |
InvalidParameterValue.AndroidAppTypeError | Android应用类型必输,请求参数中的AppType值要相等,其值需等于“apk”或“aab”。 |
InvalidParameterValue.AndroidAppUrlError | Android在线加固任务,入参字段AppUrl必输。 |
InvalidParameterValue.AndroidAssetsError | Android加固配置错误,assets资源文件路径格式错误。 |
InvalidParameterValue.AndroidEncryptParamError | Android加固配置参数不正确 |
InvalidParameterValue.AndroidResError | Android加固配置错误,res资源文件路径格式错误。 |
InvalidParameterValue.AndroidSoError | Android加固配置错误,so库文件路径格式错误。 |
InvalidParameterValue.AndroidVMPError | Android加固配置错误,vmp加固profile文件必输 |
InvalidParameterValue.AppletEncryptParamError | 小程序加固配置错误,请检查相关配置。 |
InvalidParameterValue.CheckUrlError | 请求参数中值为Url下载链接的相关字段检查不通过。 |
InvalidParameterValue.EncryptParamAppTypeError | Android加固配置错误,入参字段AppType必输。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.EncryptTaskLimitExceeded | 加固任务超过配额限制。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.ResultIdNotFound | 加固任务id不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.NotWhiteUser | 不是白名单用户。 |
UnsupportedOperation | 操作不支持。 |