License RESTful API 参考

本页面介绍控制台 License RESTful API 的详细信息。

基本信息

本节介绍所有声网控制台 License RESTful API 的基本信息。

域名

所有请求都发送给域名：api.agora.io。

认证方式

声网控制台 RESTful API 仅支持 HTTPS 协议。发送请求时，你需要使用声网提供的客户 ID 和客户密钥生成一个 Base64 算法编码的凭证，并填入 HTTP 请求头部的 Authorization 字段中。详见 如何在 RESTful API 中进行 HTTP 基本认证和 Token 认证。

调用频率限制

对于每个声网账号（非每个 App ID），本页每个 API 的调用频率上限为每秒 10 次。如果调用频率超出限制，参考 如何处理服务端 RESTful API 调用超出频率限制 优化调用频率。

激活

激活 License。

接口原型

• 方法：POST
• 接入点：https://api.agora.io/dabiz/license/v2/active

请求参数

查询参数

在请求路径中传入以下查询参数：

参数	类型	描述
pid	String	由 SKU、有效期、品类定义的 License 标识。
licenseKey	String	账号 ID 或设备 ID。
appid	String	声网分配给每个项目的唯一标识。

请求示例

请求路径

https://api.agora.io/dabiz/license/v2/active?pid=02F5xxxxxxxxxxxxxxxxxxxxxxxxEC30&licenseKey=111&appid=a6d6xxxxxxxxxxxxxxxxxxxxxxxxf75e

响应参数

如果状态码为 200，则请求成功，响应包体中包含如下参数：

参数	类型	描述
license	String	激活的 License 的值。
skuView	Array	SKU 能力集： product (Integer): 1: RTC 2: RTSA 3: FPA name (String): SKU 的名称 mediaType (Integer): 1: 音频 2: 视频 3: 音视频 minutes (Integer): License 分钟数上限 period (String): License 使用时间段

如果状态码不为 200，则请求失败。你可以根据返回的 状态码 和响应包体中 message 字段的描述进行错误排查。

响应示例

请求成功的响应示例：

{
    "code": 200,
    "data": {
        "license": "1D65xxxxxxxxxxxxxxxxxxxxxxxx6016",
        "skuView": {
            "product": 1,
            "name": "演示申请01",
            "mediaType": 1,
            "minutes": 100,
            "period": "00:00~23:59"
        }
    }
}

配额

将指定数量的 License 分配给指定项目。

接口原型

• 方法：POST
• 接入点：https://api.agora.io/dabiz/license/v2/allocate

请求参数

请求头部

参数	类型	描述
Content-Type	String	设为 application/json。

查询参数

在请求路径中传入以下查询参数：

参数	类型	描述
appid	String	声网分配给每个项目的唯一标识。

请求包体参数

在请求包体中传入以下参数：

参数	类型	描述
pid	String	由 SKU、有效期、品类定义的 License 标识。
count	Integer	License 的数量。
creator	String	执行配额操作的用户名。

请求示例

请求路径

https://api.agora.io/dabiz/license/v2/allocate?appid=a6d6xxxxxxxxxxxxxxxxxxxxxxxxf75e

请求包体

{
    "pid": "02F5xxxxxxxxxxxxxxxxxxxxxxxxEC30",
    "count": 5,
    "creator": "xxxxxxx"
}

响应参数

如果状态码为 200，则请求成功。

如果状态码不为 200，则请求失败。你可以根据返回的 状态码 和响应包体中 message 字段的描述进行错误排查。

响应示例

请求成功的响应示例：

{
    "code": 200,
    "message": "license配额成功"
}

查询配额

查询指定 License 分配给指定项目的详情。

接口原型

• 方法：GET
• 接入点：https://api.agora.io/dabiz/license/v2/product/allocations

请求参数

查询参数

在请求路径中传入以下查询参数：

参数	类型	描述
page	Integer	查询页码。
size	Integer	分页大小。
pid	String	由 SKU、有效期、品类定义的 License 标识。
appid	String	声网分配给每个项目的唯一标识。

请求示例

请求路径

https://api.agora.io/dabiz/license/v2/product/allocations?page=1&size=2&pid=02F5xxxxxxxxxxxxxxxxxxxxxxxxEC30&appid=a6d6xxxxxxxxxxxxxxxxxxxxxxxxf75e

响应参数

如果状态码为 200，则请求成功，响应包体中包含如下参数：

参数	类型	描述
count	Integer	配额次数。
list	Array	配额详情列表： pid (String): 由 SKU、有效期、品类定义的 License 标识。 type (Integer): 1: 正式 2: 测试 creator (String): 执行配额操作的用户名。 count (Integer): License 的数量。 createTime (String): 执行配额操作的时间。

如果状态码不为 200，则请求失败。你可以根据返回的 状态码 和响应包体中 message 字段的描述进行错误排查。

响应示例

请求成功的响应示例：

{
    "code": 200,
    "data": {
        "count": 2,
        "list": [
            {
                "pid": "02F5xxxxxxxxxxxxxxxxxxxxxxxxEC30",
                "type": 1,
                "creator": "xxxxxxx",
                "count": 5,
                "createTime": "2022-07-22 09:10:12"
            },
            {
                "pid": "02F5xxxxxxxxxxxxxxxxxxxxxxxxEC30",
                "type": 1,
                "creator": "xxxxxxx",
                "count": 5,
                "createTime": "2022-07-21 09:02:26"
            }
        ]
    }
}

续期

激活 License 的续期额度。

接口原型

• 方法：POST
• 接入点：https://api.agora.io/dabiz/license/v2/renew

请求参数

查询参数

在请求路径中传入以下查询参数：

参数	类型	描述
appid	String	声网分配给每个项目的唯一标识。
renewId	String	对某个 PID 进行续期操作后生成的 renewId，renewId 继承 PID 除有效期以外的全部属性。续期申请通过后，由销售提供。
license	String	续期的 License。

请求示例

请求路径

https://api.agora.io/dabiz/license/v2/renew?renewId=4750xxxxxxxxxxxxxxxxxxxxxxxx6270&license=85B3xxxxxxxxxxxxxxxxxxxxxxxx656F&appid=a6d6xxxxxxxxxxxxxxxxxxxxxxxxf75e

响应参数

如果状态码为 200，则请求成功。

如果状态码不为 200，则请求失败。你可以根据返回的 状态码 和响应包体中 message 字段的描述进行错误排查。

响应示例

请求成功的响应示例：

{
    "code": 200,
    "message": "license续期成功"
}