1. 接口描述
接口请求域名: bma.tencentcloudapi.com 。
添加品牌
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateBPBrand。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-15。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
BrandName | 是 | String | 品牌名称 示例值:腾讯安全管家 |
CompanyName | 否 | String | 企业名称 示例值:腾讯科技有限公司 |
BrandLogo | 否 | String | 品牌logo 示例值:品牌logo |
Phone | 否 | String | 联系电话 示例值:13012345678 |
License | 否 | String | 营业执照 示例值:https://test.com |
Authorization | 否 | String | 授权书 示例值:https://test.com |
TrademarkNames.N | 否 | Array of String | 商标名称 示例值:["https://test.com"] |
Trademarks.N | 否 | Array of String | 商标证明 示例值:["https://test.com"] |
IsTransfers.N | 否 | Array of String | 是否涉及转让: 0-不转让 1-转让 示例值:["1"] |
Transfers.N | 否 | Array of String | 转让证明 示例值:["https://test.com"] |
ProtectURLs.N | 否 | Array of String | 保护网址 示例值:["qq.com"] |
ProtectAPPs.N | 否 | Array of String | 保护应用 示例值:["腾讯安全管家"] |
ProtectOfficialAccounts.N | 否 | Array of String | 保护公众号 示例值:["腾讯安全管家"] |
ProtectMiniPrograms.N | 否 | Array of String | 保护小程序 示例值:["腾讯安全管家"] |
APISource | 否 | Integer | 请求来源:0-反钓鱼 2-反假冒 示例值:0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CompanyId | Integer | 企业id 示例值:123 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加品牌
添加品牌
输入示例
POST / HTTP/1.1
Host: bma.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBPBrand
<公共请求参数>
{
"CompanyName": "企业名称",
"BrandName": "品牌名称",
"BrandLogo": "品牌Logo",
"Phone": "联系电话",
"License": "营业执照",
"Authorization": "授权书",
"TrademarkNames": [
"商标名称"
],
"Trademarks": [
"商标证明"
],
"IsTransfers": [
"1"
],
"Transfers": [
"转让证明"
],
"ProtectURLs": [
"qq.com",
"baidu.com"
],
"ProtectAPPs": [
"王者荣耀",
"和平精英"
],
"ProtectOfficialAccounts": [
"人民日报",
"广东日报"
],
"ProtectMiniPrograms": [
"粤省事"
]
}
输出示例
{
"Response": {
"CompanyId": 123,
"RequestId": "xxx"
}
}
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签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidAction | 接口不存在。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
NoSuchVersion | 接口版本不存在。 |
OperationDenied | 操作被拒绝。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
ResourceInUse | 资源被占用。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
ResourcesSoldOut | 资源售罄。 |
UnauthorizedOperation | 未授权操作。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |