跳至主内容

通过API与您的应用市场集成

本节帮助合作伙伴或分销商将其集成至自有应用市场。

创建公司

开始前，您需要使用 createCompany 方法（来自 公司API ）来创建公司，

创建公司时需在请求中包含以下参数：

参数

类型

描述

备注

类型

数字

公司类型

设置为以下值：

  • 0 表示创建合作伙伴账户。

  • 1 表示创建客户账户。

licenseSubscription

对象

包含许可证详细信息的对象

将该 类型 属性设置为以下值之一：

  • 3 （月度订阅）。

  • 4 （月度许可证试用）。

  • 5 （月度订阅试用）。

名称

字符串

公司名称。

必须唯一。

parentId

字符串

您的公司ID。

请勿与公司哈希值混淆。

assignedProductType

整数

公司将要使用的产品类型。

可选值：

  • 0 表示终端安全。

  • 3 表示Bitdefender EDR。默认值为0。

重要提示

该参数仅适用于以下许可类型：

  • 3 表示按月订阅。

  • 5 表示按月订阅试用版。

附加产品类型

整数数组

公司可向其客户转售的产品类型。

数组元素的可能取值：

  • 0 表示终端安全。

  • 3 表示Bitdefender EDR。

默认值：与 assignedProductType .

注意

若设置此参数，则其至少需包含 assignedProductType .

重要提示

该参数仅适用于以下许可类型： 3 适用于月度订阅， 5 适用于月度订阅试用。

assignedProtectionModel

字符串

公司将采用的保护模型类型。

可选值：

  • aLaCarte

  • mspSecure

  • mspSecurePlus

  • mspSecureExtra

默认值：取决于合作公司提供的保护模型。

重要提示

仅当满足以下所有条件时方可使用此参数：

  • type = 3 （月度订阅）

  • assignedProductType = 0 （终端安全）

注意

此参数的赋值将自动为 additionalProtectionModels 数组分配一个或多个值。

assignedProtectionModel

的默认值适用于 additionalProtectionModels

aLaCarte

aLaCarte

mspSecure

mspSecure

mspSecurePlus

mspSecure , mspSecurePlus

mspSecureExtra

mspSecure , mspSecurePlus , mspSecureExtra

additionalProtectionModels

字符串数组

该参数允许创建的合作伙伴公司为其客户分配除 assignedProtectionModel 对象提供的保护模型之外的其他保护模型。

可选值：

  • aLaCarte

  • mspSecure

  • mspSecurePlus

  • mspSecureExtra

默认值：取决于 assignedProtectionModel 字段的赋值。

重要提示

仅当满足以下任一条件时方可使用此参数：

  • assignedProductType = 3 （Bitdefender EDR）, additionalProductType 必须包含 0 （终端安全）, 且 type = 3 （月度订阅）.

  • assignedProductType = 0 （终端安全）, type = 3 （月度安全）, 且 assignedProtectionModel 包含在请求中。

accountEmail

字符串

需关联至新公司的新用户账户邮箱。

若参数 canBeManagedByAbove 设置为 false ，则 accountEmail 该参数必须包含在内。

accountFullName

字符串

待关联至新公司的新用户账户全名。

当 canBeManagedByAbove 设置为 false .

contactPerson

对象

包含公司指定联系人的相关信息。

该对象包含以下字段：

  • fullName - 联系人的姓名。

  • email - 其商务邮箱地址。

    重要提示

    当请求中包含 contactPerson 参数时，此字段为必填项。

  • phoneNumber ，其商务电话号码。

  • companyRole ，其在公司中的职位。

您可通过使用 createCompany 文章中描述的可选参数进一步定制请求。

返回值 ：此方法返回一个包含新创建公司ID的字符串。您可将此字符串用于其他工作流程。

有关此方法的更多信息，请参阅 createCompany .

返回示例 : 

{
    "id":"e249c22c-0ada-4772-a9f1-ee1cbb322588",
    "jsonrpc":"2.0",
    "result": "5493dcd2b1a43df00b7b23c6"
}

为公司分配月度订阅

您可以使用 setMonthlySubscription 方法实现以下功能：

  • 将公司试用许可证切换为月度订阅。

  • 为已订阅月费的管理公司启用或禁用附加组件。

  • 更改公司正在使用或被允许分发的保护模型。

  • 将公司许可模式从年度订阅更改为月度订阅。

按任意顺序设置下列参数：

参数

类型

可选性

说明

manageExchange

布尔值

是

设为True允许公司使用Exchange安全服务，反之为False。默认值为False。

manageEncryption

布尔值

是

设为True允许公司使用全盘加密服务，反之为False。默认值为False。

manageRemoteEnginesScanning

布尔值

是

设为True允许公司使用虚拟化环境安全服务，反之为False。默认值为False。

注意

若存在 manageRemoteEnginesScanning 或 manageRemoteEnginesScanningResell 参数设置于 ownUse 或 resell 对象参数下时，则不可使用本参数。

manageHyperDetect

布尔型

是

设为True允许企业使用HyperDetect服务，False则禁止。默认值为False。

manageSandboxAnalyzer

布尔型

是

设为True允许企业使用沙箱分析服务，False则禁止。默认值为False。

managePatchManagement

布尔型

是

设为True允许企业使用补丁管理服务，False则禁止。默认值为False。

manageEventCorrelator

布尔型

是

设为True允许企业使用端点检测与响应(EDR)服务，False则禁止。默认值为False。启用EDR需同时开启沙箱分析器和HyperDetect。本参数值变更将自动同步修改manageSandboxAnalyzer和manageHyperDetect参数值。若未传值则不影响这两个参数的现有设置。

manageEmailSecurity

布尔型

是

设为True允许企业使用邮件安全服务，False则禁止。默认值为False。

manageMobileSecurity

布尔值

是

设为True允许公司使用移动安全服务，False则不允许。默认值为False。

manageContainerProtection

布尔值

是

设为True允许公司使用容器保护服务，False则不允许。默认值为False。

重要提示

该设置仅在 assignedProtectionModel 被分配了 aLaCarte 值时才能设为true。

注意

若存在 manageContainerProtection 或 manageContainerProtectionResell 参数位于 ownUse 或 resell 对象参数中时，则不可使用此参数。

licensedServices

对象

是

包含公司服务设置的对象。

该参数仅在创建许可证类型为 3 若省略此项，则该服务将不可用。

  • mdrServiceOwnUse ，一个整数，表示公司自用的MDR服务类型。可选值：0表示禁用，1表示基础版。若公司类型为合作伙伴，启用此选项将同时启用MDR服务转售功能。启用此选项也将同时启用EDR。若省略此项，则该服务将不可用。

  • mdrServiceResell ，一个布尔值，指定是否允许公司向其所创建的公司转售MDR服务。若省略此项，则转售功能将不可用。此参数仅对合作伙伴公司有意义。

assignedProductType

数字

是

分配给目标公司的产品类型。可选值：

  • 0 ，表示终端安全

  • 3 ，表示Bitdefender EDR

默认值为0。

additionalProductTypes

数组

是

此参数仅适用于合作伙伴公司。它是一个整数数组，表示合作伙伴可以分配给其客户的产品类型。可能的整数值：

  • 0 ，表示终端安全

  • 3 ，表示Bitdefender EDR

若设置此参数，数组必须至少包含 assignedProductType 的值，并且您还必须设置 assignedProductType 。若未设置，默认值为 assignedProductType .

assignedProtectionModel

字符串

是

分配的保护模型 ，表示公司将采用保护模型类型的字符串。

可选值：

  • aLaCarte

  • mspSecure

  • mspSecurePlus

  • mspSecureExtra

默认值：取决于合作公司提供的保护模型。

仅在满足以下所有条件时方可使用此参数：

  • 类型 = 3 （月度订阅）

  • 分配的产品类型 = 0 （终端安全）

注意

该参数的赋值将自动为 additionalProtectionModels 数组分配一个或多个值。

assignedProtectionModel

默认值适用于 additionalProtectionModels

aLaCarte

aLaCarte

mspSecure

mspSecure

mspSecurePlus

mspSecure , mspSecurePlus

mspSecureExtra

mspSecure , mspSecurePlus , mspSecureExtra

additionalProtectionModels

字符串

是

表示保护模型类型的字符串数组。该参数允许合作伙伴公司为其客户分配除 assignedProtectionModel 对象提供的保护模型之外的额外保护模型。

可选值：

  • aLaCarte

  • mspSecure

  • mspSecurePlus

  • mspSecureExtra

默认值：取决于 assignedProtectionModel 字段的赋值。

仅当满足以下任一条件时方可使用此参数：

  • assignedProductType = 3 （Bitdefender EDR）， additionalProductType 必须包含 0 (终端安全)，且 类型 = 3 (按月订阅)。

  • 分配产品类型 = 0 (终端安全), 类型 = 3 (月度安全)，且 分配保护模型 已包含在请求中。

管理完整性监控

整数

是

真 表示允许公司使用完整性监控服务， 假 否则。默认值为 假 .

完整性监控数据保留

整数

否

事件将被存储的天数。仅当 manageIntegrityMonitoring 为 true 时的可选值： 0 ( 7 天保留期）， 1 ( 90 天保留期）， 2 ( 180 天保留期）， 3 ( 365 天保留期）。默认值为 0 ( 7 天保留期）。

ownUse

对象

是

包含公司服务及附加功能激活设置的对象。该参数仅在创建许可证类型为3或5（月度继承订阅）的公司时有效。

  • manageXDRIdentityProviders ，提供对Azure AD和Active Directory的传感器管理集成访问权限。可选值： true 或 false .

  • manageXDRProductivityApps ，提供对Office 365、Google Workspace和Microsoft Intune的传感器管理集成访问权限。可选值： true 或 false .

  • manageXDRNetwork ，提供对网络传感器的传感器管理集成访问权限。可选值： true 或 false .

  • manageXDRCloudWorkloads ，提供对AWS和Azure云的传感器管理集成访问权限。可选值： true 或 false .

    重要提示

    要为上述任一参数分配 true 值，必须将 manageEventCorrelator 参数或 manageEventCorrelator 设置置于 ownuse 参数需设置为 true .

    注意

    将 true 赋给以下任一参数： manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork 或 manageXDRCloudWorkloads 设置将激活XDR功能。若要停用XDR，需将所有参数设为 false .

  • manageRemoteEnginesScanning 为可选参数，用于为贵公司激活虚拟化环境安全服务。可选值： true 或 false 。默认值： false .

    注意

    若 manageRemoteEnginesScanning 参数位于 自用 对象存在时。

  • 容器保护管理 ，可选。为您的公司激活容器保护服务。可选值： true 或 false 。默认值： false .

    重要提示

    仅当 分配的保护模型 被赋予 按需选择 值时，此设置才能设为true。

    注意

    若 容器保护管理 参数存在于 自用 对象之外，则不可使用此设置。

  • 事件关联器管理 ，布尔值，指定公司是否可使用端点检测与响应（EDR）。默认值为 false 。将此参数设为 true 将自动设置 沙箱分析器管理 及 manageHyperDetect 参数下的设置 ownuse 设为 true .

    注意

    若存在 manageEventCorrelator 参数在 ownUse 对象外部时，此设置不可用。

  • manageSandboxAnalyzer ，布尔值，指定公司是否可使用沙箱分析器。默认值为 false .

    注意

    若存在 manageSandboxAnalyzer 参数在 ownUse 对象外部时，此设置不可用。

  • manageHyperDetect ，布尔值，指定公司是否可使用HyperDetect。默认值为 false .

    注意

    若存在 manageHyperDetect 参数在 ownUse 对象存在时不可使用此设置。

resell

对象

是

一个包含贵公司服务和附加组件转售设置的对象。该参数仅在创建许可证类型为3或5（月度继承订阅）的公司时有意义。

  • manageXDRResell - 允许向客户销售扩展检测与响应服务。可选值： true 或 false .

    注意

    若设为 true ，则 manageXDRIdentityProviders , manageXDRProductivityApps , manageXDRNetwork 及 manageXDRCloudWorkloads 将自动设置为 true （针对您管理的公司）。

  • manageRemoteEnginesScanningResell （可选）允许向客户销售虚拟化环境安全服务。可选值： true 或 false 。默认值： false .

    注意

    若在 manageRemoteEnginesScanning 参数存在于 resell 对象外部时，此设置不可用。

  • manageContainerProtectionResell ，可选，允许向客户销售容器保护服务。可选值： true 或 false 。默认值： false .

    重要提示

    仅当 additionalProtectionModels 参数被赋值为 aLaCarte 时，此设置方可设为true。

    注意

    若在 manageContainerProtection 参数存在于 ownUse 对象外部时，此设置不可用。

  • manageEventCorrelatorResell ，可选参数，允许向客户销售终端检测与响应（EDR）服务。可选值： true 或 false 。默认值： false 。若将此参数设为 true ，将自动将 manageSandboxAnalyzerResell 和 manageHyperDetectResell 参数（位于 resell 参数下）设置为 true .

    注意

    ：若存在 manageEventCorrelator 参数位于 ownUse 对象之外，则不可使用此设置。

  • manageSandboxAnalyzerResell ，可选参数，允许向客户销售沙箱分析服务。可选值： true 或 false 。默认值： false .

    注意

    若存在 manageSandboxAnalyzer 参数位于 ownUse 对象之外，则此设置不可用。

  • manageHyperDetectResell （可选）允许向客户销售HyperDetect。默认值为 false .

    注意

    若存在 manageHyperDetect 参数位于 ownUse 对象之外，则此设置不可用。

请求示例 : 

{
    "params": {
        "companyId": "64be4c5cb904ea72f3001049",
        "reservedSlots": 120,
        "removeReservedSlots": false,
        "endSubscription": "2029-04-14",
        "autoRenewPeriod": 12,
        "manageExchange": false,
        "manageEncryption": false,
        "managePatchManagement": false,
        "ownUse": {
            "manageXDRIdentityProviders": false,
            "manageXDRProductivityApps": false,
            "manageXDRNetwork": false,
            "manageXDRCloudWorkloads": false,
            "manageRemoteEnginesScanning": false,
            "manageContainerProtection": false,
            "manageHyperDetect": true,
            "manageSandboxAnalyzer": true,
            "manageEventCorrelator": true
        },
        "resell": {
            "manageXDRResell": true,
            "manageRemoteEnginesScanningResell": true,
            "manageContainerProtectionResell": true,
            "manageHyperDetectResell": true,
            "manageSandboxAnalyzerResell": true,
            "manageEventCorrelatorResell": true
        },
        "manageEmailSecurity": false,
        "manageIntegrityMonitoring": true,
        "imDataRetention": 2,
        "licensedServices": {
            "mdrServiceOwnUse": 1,
            "mdrServiceResell": true
        },
        "minimumUsage": {
            "endpointMonthlyUsage": 120
        },
        "assignedProductType": 0,
        "additionalProductTypes": [
            0
        ],
        "assignedProtectionModel": "mspSecure",
        "additionalProtectionModels": [
            "aLaCarte",
            "mspSecure",
            "mspSecurePlus"
        ],
        "setNewProtectionModelForClients": "aLaCarte"
    },
    "jsonrpc": "2.0",
    "method": "setMonthlySubscription",
    "id": "d4d50719-3215-455a-a329-086fe77f6d72"
}

返回值 ：此方法不返回任何值。

有关此方法的更多信息，请参阅 createCompany .

返回示例 :

MSP会收到来自 Bitdefender 其中包含指向 GravityZone 控制台的链接及其预配的登录凭据。我们建议MSP在首次登录时修改密码。

注意

若需根据实际用量计费而不设置MSP许可证消耗的硬性上限，则无需指定 reservedSlots 参数。

月末用量核查

若未启用任何附加功能，您可直接通过 getMonthlyUsage 方法，指定 targetMonth 和 companyID 参数来获取月度用量数据。

进行月末用量核查时，按任意顺序设置以下参数：

参数

类型

描述

companyID

字符串

公司ID。默认值为生成API密钥的用户关联的公司ID。

targetMonth

字符串

需返回用量数据的月份。格式应为： mm/yyyy 。默认值为当前月份。

请求示例 : 

{
       "params": {
           "targetMonth": "03/2015",
           "companyId": "55115935b1a43dcc4a7b23c6"
       },       "jsonrpc": "2.0",
       "method": "getMonthlyUsage", 
       "id": "5087eab8-b74f-4a3e-85b3-4271e85890d4"
  }

返回值 :

该方法返回一个对象，包含指定月份内每项已购服务所使用的许可证席位数量，若查询公司无月度许可证则返回0：

  • endpointMonthlyUsage - 使用本地引擎扫描的所有端点的月度使用量。

  • aLaCarteMonthlyUsage - 使用本地引擎扫描的端点月度使用量，这些端点所属公司采用 按需定制 防护模式。

  • mspSecureMonthlyUsage - 使用本地引擎扫描的端点月度使用量，这些端点所属公司采用 安全版 防护模式。

  • mspSecurePlusMonthlyUsage - 使用本地引擎扫描的端点月度使用量，这些端点所属公司采用 安全增强版 防护模式。

  • mspSecureExtraMonthlyUsage - 使用本地引擎扫描的端点月度使用量，这些端点所属公司采用 安全旗舰版 防护模式。

  • emailSecurityMonthlyUsage - 邮件安全邮箱的月度使用量。

  • mobileSecurityMonthlyUsage - 移动安全设备的月度使用量。

  • exchangeMonthlyUsage - Exchange邮箱的月度使用量。

  • encryptionMonthlyUsage - 加密模块的月度使用量。

  • atsMonthlyUsage - 沙盒分析器和高级检测模块的月度使用量。

  • edrMonthlyUsage - EDR模块的月度使用量。

  • mdrFoundationsMonthlyUsage - MDR基础服务的月度使用量。

  • patchManagementMonthlyUsage - 补丁管理模块的月度使用量。

  • containerProtectionMonthlyUsage - 容器保护模块的月度使用量。

  • integrityMonitoringUsage - 使用完整性监控的终端总数。

  • integrityMonitoring90DaysUsage - 使用90天事件保留期完整性监控的终端数量。

  • integrityMonitoring180DaysUsage - 使用180天事件保留期完整性监控的终端数量。

  • integrityMonitoring1YearUsage - 使用1年事件保留期完整性监控的终端数量。

  • xdrIdentitySensorsMonthlyUsage ，传感器管理中Azure AD和Active Directory集成的月度使用量。

  • xdrProductivitySensorsMonthlyUsage ，传感器管理中Office 365集成的月度使用量。

  • xdrNetworkSensorsMonthlyUsage ，传感器管理中网络传感器集成的月度使用量。

  • xdrCloudSensorsMonthlyUsage ，传感器管理中AWS集成的月度使用量。

  • sveVsMonthlyUsage - 使用安全服务器扫描的虚拟服务器月度使用量。

  • sveVdiMonthlyUsage - 使用安全服务器扫描的虚拟桌面月度服务使用量（按小时计）。

  • minimumUsage - 一个包含许可证类型及公司通过法律协议承诺每月最低使用量的对象：

    • endpointMonthlyUsage ，客户同意从主许可证中使用的最低端点数量。

返回示例 : 

{
  "result": {
    "endpointMonthlyUsage": 4,
    "encryptionMonthlyUsage": 0,
    "emailSecurityMonthlyUsage": 0,
    "mobileSecurityMonthlyUsage": 0,
    "exchangeMonthlyUsage": 0,
    "atsMonthlyUsage": 0,
    "edrMonthlyUsage": 0,
    "mdrFoundationsMonthlyUsage": 0,
    "patchManagementMonthlyUsage": 0,
    "integrityMonitoringUsage": 0,
    "integrityMonitoring90DaysUsage": 0,
    "integrityMonitoring180DaysUsage": 0,
    "integrityMonitoring1YearUsage": 0,
    "sveVsMonthlyUsage": 0,
    "sveVdiMonthlyUsage": 0,
    "containerProtectionMonthlyUsage": 0,
    "xdrIdentitySensorsMonthlyUsage": 0,
    "xdrProductivitySensorsMonthlyUsage": 0,
    "xdrNetworkSensorsMonthlyUsage": 0,
    "xdrCloudSensorsMonthlyUsage": 0,
    "aLaCarteMonthlyUsage": 1,
    "mspSecureMonthlyUsage": 1,
    "mspSecurePlusMonthlyUsage": 0,
    "mspSecureExtraMonthlyUsage": 2
  },
  "jsonrpc": "2.0",
  "id": "5986",
  "error": null
}

有关此方法的更多信息，请参阅 getMonthlyUsage .

如需获取为您的MSP启用的附加组件的使用计算器和报告，请参考 使用月度许可证使用报告计算端点使用量 .

获取公司ID

使用 findCompaniesByName 方法（来自公司API）获取公司ID、其使用情况或公司详细信息。有关此方法的更多信息，请参阅 findCompaniesByName .

检索公司的许可信息

使用 getLicenseInfo 方法（来自许可API）检索公司的许可信息。有关此方法的更多信息，请参阅 getLicenseInfo .

在合同违约时暂停MSP账户

当发生合同协议违约时，您始终掌握控制权并能够采取行动。

公司API中的 suspendCompany 方法允许您暂停未支付账单或其他合同违约的活跃公司。

在这种情况下，您可以暂停公司访问权限并停用相关端点。您可以选择递归应用于MSP管理的所有公司，以防止在给定月份内使用量累积。有关此方法的更多信息，请参阅 suspendCompany .

要激活被暂停的公司，请参阅 activateCompany .

本节内容 :