内测分发 API 使用文档

接入说明

使用 Bugly 内测分发 API,开发者可以通过调用接口的方式实现版本自动上传、版本列表查询、版本详细信息查询等功能。让开发者更简单、更顺畅的进行应用分发。

API的调用协议为HTTPS, 接口返回数据格式为JSON。所有接口调用均包含app_key、app_id、pid这三个参数。

app_key:用于识别API调用者身份,创建应用时自动获得

app_id:应用编号,用于识别产品的唯一ID

pid:应用平台标识,用于区分产品平台

版本发布

接口名称:发布新版本

接口用法

POST   multipart/form-data   https://api.bugly.qq.com/beta/apiv1/exp

请求参数

参数名 必填 参数说明
app_id 用于识别API调用者身份,创建应用时自动获得
app_key 应用编号,用于识别产品的唯一ID
pid 应用平台标识,用于区分产品平台 android:1 iOS: 2
file 安装包,apk/ipa格式
title 版本名称,如有中文必须UTF-8格式
description 版本描述,如有中文必须UTF-8格式
secret 公开范围(1:所有人, 2:密码, 4:管理员, 5:QQ群, 6:白名单,默认所有人)
users 公如果公开范围是"QQ群"填QQ群号;如果公开范围是"白名单"填QQ号码,并使用;切分开,5000个以内。其他场景无需设置
password 密码(如果公开范围是"密码"需设置)
download_limit 下载上限(大于0,默认1000)

示例

curl --insecure -F "file=@demo.apk" -F "app_id={app_id}" -F "pid={pid}" -F "title={title}" -F "description={description}" -F "secret={secret}" -F "password={password}" -F "users={users}" -F "download_limit={download_limit}" https://api.bugly.qq.com/beta/apiv1/exp?app_key={app_key}

返回值: 格式为 application/json

{
    "rtcode": 0,
    "msg": "Success",
    "data": {
        "app_id": "900000000",
        "pid": "1",
        "title": "demo",
        "description": "demo description",
        "secret": "5",
        "users":"123456",
        "url": "http://beta.qq.com/m/abcd",
        "download_limit": "10",
        "status": "1",
        "create_time": "2015-12-16 19:01:56",
        "update_time": "2015-12-16 19:01:56",
        "exp_id": "c84f98d3-af9d-4840-a42f-12f688x4fx7x",
        "version": "1.47.0.10470",
        "md5": "B58D2D81631E2E43C4EC378906CEXD31",
        "creator": "900000000_1",
        "download_num": "0",
        "feedback_num": "0"
    }
}

返回值说明

参数名 参数说明
rtcode 0表示正常,其他错误码
msg 返回码说明
app_id 应用编号,用于识别产品的唯一ID(与API调用参数一致)
pid 应用平台标识,用于区分产品平台(与API调用参数一致)
title 版本名称(与API调用参数一致)
description 版本描述(与API调用参数一致)
secret 公开范围(与API调用参数一致)
password 密码(与API调用参数一致)
users 指定用户或者用户群(与API调用参数一致)
url 下载页地址
download_limit 下载上限(与API调用参数一致)
status 版本状态,1:正常 -1:关闭 -2:删除
create_time 版本创建时间
update_time 版本更新时间
exp_id 体验id,后续可根据此id查询版本信息
version 安装包版本号
md5 安装包md5值
creator 版本发布者
download_num 用户下载次数
feedback_num 用户反馈次数

替换版本安装包

接口名称:替换版本安装包

接口方法

PUT  https://api.bugly.qq.com/beta/apiv1/exp

请求参数

参数名 必填 参数说明
app_key 应用编号,用于识别产品的唯一ID
exp_id 需替换安装包的版本id
file 安装包,apk/ipa格式
title 版本名称,如有中文必须UTF-8格式
description 版本描述,如有中文必须UTF-8格式
secret 公开范围(1:所有人, 2:密码, 4:管理员, 5:QQ群, 6:白名单,默认所有人)
users 公如果公开范围是"QQ群"填QQ群号;如果公开范围是"白名单"填QQ号码,并使用;切分开,5000个以内。其他场景无需设置
password 密码(如果公开范围是"密码"需设置)
download_limit 下载上限(大于0,默认1000)

示例

curl --insecure -X "PUT" -F "file=@demo.apk" -F "exp_id={exp_id}" -F "title={title}" -F "description={description}" -F "secret={secret}" -F "password={password}" -F "users={users}" -F "download_limit={download_limit}" https://api.bugly.qq.com/beta/apiv1/exp?app_key={app_key}

返回值: 格式为 application/json

{
    "rtcode": 0,
    "msg": "Success",
    "data": {
        "app_id": " 900000000",
        "pid": "1",
        "title": " demo",
        "description": " demo description",
        "secret": " 5",
        "users":"123456",
        "url": " http://beta.qq.com/m/abcd",
        "download_limit": "20",
        "status": "1",
        "create_time": "2016-07-04 11:26:59.000",
        "update_time": "2016-07-06 16:13:35.000",
        "exp_id": " c84f98d3-af9d-4840-a42f-12f688x4fx7x",
        "version": "2.2.0",
        "creator": "90000000_1",
        "download_num": "1",
        "feedback_num": "0"
    }
}

版本查询

接口名称:查询版本详细信息

接口用法

GET   https://api.bugly.qq.com/beta/apiv1/exp

请求参数

参数名 必填 参数说明
app_key 用于识别API调用者身份,创建应用时自动获得
app_id 应用编号,用于识别产品的唯一ID
pid 应用平台标识,用于区分产品平台 android:1 iOS: 2
exp_id 版本唯一标识ID

示例

curl --insecure "https://api.bugly.qq.com/beta/apiv1/exp/{exp_id}?app_id={app_id}&pid={pid}&app_key={app_key}"

返回值: 格式为 application/json

{
    "rtcode": 0,
    "msg": "Success",
    "data": {
        "app_id": "900000000",
        "pid": "1",
        "title": "demo",
        "description": "demo description",
        "secret": "5",
        "users":"123456",
        "url": "http://beta.qq.com/m/abcd",
        "download_limit": "10",
        "status": "1",
        "create_time": "2015-12-16 19:01:56",
        "update_time": "2015-12-16 19:01:56",
        "exp_id": "c84f98d3-af9d-4840-a42f-12f688x4fx7x",
        "version": "1.47.0.10470",
        "md5": "B58D2D81631E2E43C4EC378906CE6D31",
        "creator": "900000000_1",
        "download_num": "0",
        "feedback_num": "0"
    }
}

返回值说明

参数名 参数说明
rtcode 0表示正常,其他错误码
msg 返回码说明
app_id 应用编号,用于识别产品的唯一ID(与API调用参数一致)
pid 应用平台标识,用于区分产品平台(与API调用参数一致)
title 版本名称(与API调用参数一致)
description 版本描述(与API调用参数一致)
secret 公开范围(与API调用参数一致)
password 密码(与API调用参数一致)
users 指定用户或者用户群(与API调用参数一致)
url 下载页地址
download_limit 下载上限(与API调用参数一致)
status 版本状态,1:正常 -1:关闭 -2:删除
create_time 版本创建时间
update_time 版本更新时间
exp_id 体验id,后续可根据此id查询版本信息
version 安装包版本号
md5 安装包md5值
creator 版本发布者
download_num 用户下载次数
feedback_num 用户反馈次数

版本列表查询

接口名称:查询app所有版本详细信息

接口用法

GET   https://api.bugly.qq.com/beta/apiv1/exp_list

请求参数

参数名 必填 参数说明
app_key 用于识别API调用者身份,创建应用时自动获得
app_id 应用编号,用于识别产品的唯一ID
pid 应用平台标识,用于区分产品平台
start 结果开始位置(从0开始),按创建时间逆序
limit 返回结果条数,最大100

示例

curl --insecure "https://api.bugly.qq.com/beta/apiv1/exp_list?app_id={app_id}&pid={pid}&app_key={app_key}&start={start}&limit={limit}"

返回值: 格式为 application/json

{
    {
    "rtcode": 0,
    "msg": "Success",
    "data": {
        "total": 79,
        "list": [
            {
            "app_id": "900000000",
            "pid": "1",
            "title": "demo",
            "description": "demo description",
            "secret": "2",
            "password": "1234",
            "url": "http://beta.qq.com/m/abcd",
            "download_limit": "10",
            "status": "1",
            "create_time": "2015-12-17 10:42:36",
            "update_time": "2015-12-17 10:42:36",
            "exp_id": "d9f1cc16-12b4-43ab-86b6-1e8x4dcx5f6x",
            "version": "1.47.0.10470",
            "md5": "B58D2D81631E2E43C4EC378906XE6D31",
            "creator": "90000000_1",
            "download_num": "0",
            "feedback_num": "0"
    },
    {
            "app_id": "900000000",
            "pid": "1",
            "title": "demo",
            "description": "demo description",
            "secret": "6",
            "users":"123456;123457",
            "url": "http://beta.qq.com/m/abcd",
            "download_limit": "10",
            "status": "1",
            "create_time": "2015-12-17 10:42:24",
            "update_time": "2015-12-17 10:42:24",
            "exp_id": "7f2e6a5d-bed6-43c9-a435-8x17x954de2c",
            "version": "1.47.0.10470",
            "md5": "B58D2D81631E2E43C4EC378906CX6D31",
            "creator": "900000000_1",
            "download_num": "0",
            "feedback_num": "0"
        }
    ]
    }
}

返回值说明

参数名 参数说明
rtcode 0表示正常,其他错误码
msg 返回码说明
app_id 应用编号,用于识别产品的唯一ID(与API调用参数一致)
pid 应用平台标识,用于区分产品平台(与API调用参数一致)
title 版本名称(与API调用参数一致)
description 版本描述(与API调用参数一致)
secret 公开范围(与API调用参数一致)
password 密码(与API调用参数一致)
users 指定用户或者用户群(与API调用参数一致)
url 下载页地址
download_limit 下载上限(与API调用参数一致)
status 版本状态,1:正常 -1:关闭 -2:删除
create_time 版本创建时间
update_time 版本更新时间
exp_id 体验id,后续可根据此id查询版本信息
version 安装包版本号
md5 安装包md5值
creator 版本发布者
download_num 用户下载次数
feedback_num 用户反馈次数

返回错误码

调用方错误

错误码 错误码返回说明
40400 参数错误,请检查参数输入是否正确
40401 登录失败,请检查app_key与app_id是否正确
40403 资源无权限,请检查app_key与app_id是否正确
40404 未找到资源

平台错误

| 错误码 | 错误码返回说明 | | ---- | ----| ----| | 50500 | 系统内部错误 |