开发

API 列表

小程序基本信息查询接口

接口功能

小程序基本信息查询

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/app/info

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间(精确到秒)
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组 成
access_token String 是 access_token
app_keys String 是 支持多个 app_keys，使用英文逗号分隔多个,最多一次 支持 10 个

返回字段

Data Array

字段 类型 描述
app_key string 小程序的 appkey
app_name string 小程序的名称
app_desc string 小程序的介绍内容
developer_id string 小程序开发者 ID
photo_addr string 小程序 logo
qualification object 小程序账号对应的主体信息
category list 小程序的行业信息
min_swan_version string 开发者工具最低版本
has_ai int 是否使用 AI 能力 0-未使用 1-使用
has_privilege int 是否使用宿主私有能力 0-未使用 1-使用
guard int 是否加入容灾词典 0-未加入 1-加入
status int 小程序的状态 -1 代表封禁，1 代表正常，2 代 表审核中，4 代表暂停服务 ，5 强制下线
appAwakenPath string 小程序首页 Path

注:使用 AI、私有能力，如果宿主未实现对应功能，对使用小程序体验会产生影 响，请慎重使用。 加入容灾的小程序请酌情分发

qualification 对象

字段 类型 描述
name string 主体名称
type int 主体类型: 1:个人 2 企业 3: 政府 4:媒 体 5:其他
satus int 0:未操作 1:通过 2:审核中 3:审核失败 4:推送失败
ad_type int 高级认证类型,0:未做高级认证、1:对公验证、2: 活体验证
ad_status int 高级认证状态,1:通过、3:失败

category 对象:

字段 类型 描述
category_id string 二级行业 id
category_name string 二级行业名称
category_desc string 二级行业说明
parent object 上级行业(父类行业)，如果没有上级行 业，为 null，格式说明见 parent category 对象说明

parent category 对象:

字段 类型 描述
category_id string 二级行业 id
category_name string 二级行业名称
category_desc string 二级行业说明

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
{
  errno: 0,
  msg: "success",
  data: [
    {
      app_key: "v95ssxxkjsjffw",
      app_name: "app测试名称1",
      app_desc: "测试描述1",
      developer_id:“20fe1b2807426129a27743ba9493e5d0",
      photo_addr: "https://b.bdstatic.com/searchbox/mappconsole/image/20180707/1530930140155636.jpg",
      qualification: {

      },
      category: [

      ],
      min_swan_version: "",
      has_ai:1,
      has_privilege:0,
      status: 1
    },
    {
      app_key: "Z6Scwa8CApGGjUo6QCIp",
      app_name: "APP测试名称2",
      app_desc: "测试描述2",
      developer_id:“20fe1b2807426129a27743ba9493e5d0",
      photo_addr: "https://b.bdstatic.com/searchbox/mappconsole/image/20180711/1531306975136473.jpg",
      qualification: {
        name: "百度（中国）有限公司",
        type: 2,
        status: 1,
        ad_type: 2,
        ad_status: 1
      },
      category: [
        {
          category_id: 178,
          category_name: "效率",
          category_desc: "工具",
          parent: null
        },
        {
          category_id: 189,
          category_name: "信息查询",
          category_desc: "信息查询功能",
          parent: {
            category_id: 178,
            category_name: "信息查询",
            category_desc: "信息查询功能"
          }
        }
      ],
      min_swan_version: "10.2.3",
      has_ai:1,
      has_privilege:0,
      status: 1
    }
  ]
}

小程序包列表获取

接口功能

查询小程序包 list

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/package/infolist

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组 成。
access_token String 是 access_token
app_key String 是 小程序唯一标识号

返回字段

Data Array 说明:

字段 类型 描述
package_id int 代码包 id
version string 版本号
remark string 备注说明
msg string 审核信息内容
status int 状态 1:线上版本，2:上一个线上版本;8:回滚中
commit_time string 提交时间
version_desc int 版本描述
package_type int 包类型 1完整包,2主包,3子包

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
	errno: 0,
	msg: "success",
	data: [
		{
			package_id: 2319,
			version: "1.5",
			remark: "录音提示已经去掉了的。您请清除一下百度 app 缓存，点击右下角我的-》设置-》清除缓存",
			msg: "审核通过",
			status: 1,
			commit_time: 1536057036,
			version_desc: "录音提示已经去掉了的。",
			package_type: 1
		}, {

			package_id: 2280, version: "0.0.0", remark: "",
			msg: "",
			status: 8,
			commit_time: 1535940977,
			version_desc: "",
			package_type: 2
		}
	]
}

小程序包详情接口

接口功能

查询小程序包详情

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/package/detail

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token
app_key String 是 小程序唯一标识号
package_id Int 是 小程序对应的包的 ID

返回字段

字段 类型 描述
package_id int 代码包 id
version string 版本号
remark string 备注说明
msg string 审核信息内容
status int 状态 说明:1:线上版本，2:上一个线上版本，8: 回滚中
commit_time int 提交时间
version_desc string 版本描述
package_type int 包类型 1完整包,2主包,3子包

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
	errno: 0,
	msg: "success",
	data: {
		package_id: 90899,
		version: "1.0.10",
		remark: "",
		msg: "审核通过",
		status: 1,
		commit_time: 1544168617,
		version_desc: "版本更新，增加新的入口 版本更新，增加新的入口 版本更新，增加新的入口 ",
		package_type: 1
	}
}

小程序权限列表接口

接口功能

查询小程序权限列表

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/app/privilege

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 签名，生成方式见签名说明
union_timestamp Long 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String access_token
app_key String 小程序唯一标识号

返回字段

字段 类型 描述
pri_type int 权限类型 1 用户权限, 2 设备权限 3 服务权限
pri_scope string 权限英文信息
pri_name string 权限名称
grade int 权限分级 1 单次授权，2 终身授权，3 无需授权
forbidden bool 是否被禁用 true:禁用，false:有效

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
{
	errno: 0,
	msg: "success",
	data: [
		{
			pri_type: 1,
			pri_scope: "mapp_b_app_push",
			pri_name: "app 消息通知",
			grade: 1,
			forbidden: true
		}
	]
}

权限码表接口

接口功能

查询权限码表

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/privilege/list

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token

返回字段

字段 类型 描述
pri_type int 权限类型 1 用户权限, 2 设备权限 3 服务权限
pri_scope string 权限英文信息
pri_name string 权限名称
grade int 权限分级 1 单次授权，2 终身授权，3 无需授权
explain String 场景说明
sub_explain String 辅助场景说明
forbidden bool 是否被禁用 true:禁用，false:有效

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
	errno: 0,
	msg: "success",
	data: [
		{
			pri_type: 1,
			pri_scope: "mapp_b_app_push",
			pri_name: "app 消息通知",
			grade: 1,
			explain: "场景说明 1",
			sub_expain: "辅助场景说明 1",
			forbidden: true
		}
	]
}

小程序全量批量获取接口

接口功能

批量查询小程序列表

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/app/batch

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token
start_index int 是 每次拉取的起始位置，size 平台固定 100，起始位置从 0 开始循环拉取每次增加 100，startIndex=0,100,200; 拉取到空停止拉取

返回字段

字段 类型 描述
app_key string 小程序唯一标识
app_name string 小程序名称

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
{
	errno: 0,
	msg: "success",
	data: [
		{
			app_key: "v955gWycqSaWfxUNBbZxiyAfMCMuizO7",
			app_name: "app 小程序名字 1"
		}, {
			app_key: "Z6Scwa8CApxxk8RQFXN0RjGGjUo6QCIp",
			app_name: "app 小程序名字 2"
		}
	]
}

小程序推荐接口

接口功能

获取小程序推荐列表(需要和百度侧确认后才能使用)

URL

https://openapi.baidu.com/rest/2.0/smartapp/recommend/applist

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token
pkg_info String 是 通过端 API 获取的端内信息
base String 是 索引值，默认“”(保留字段暂时不支持加载更多)
num Int 是 返回的数量
province String 是 省
city String 是 市
longitude String 是 经度
latitude String 是 纬度

返回字段

Data Object说明

字段 类型 描述
app_list Array 小程序列表
list_num int 返回的小程序数量
has_more int 0:表示没有更多 1:表示还有更多
base string 加载更多时带回的请求索引值

List_num Array 说明

字段 类型 描述
appkey string 小程序key
name string 小程序名字
icon string 小程序图标
description string 小程序描述
schema string 小程序的调起 schema
frame_type int 小程序和小游戏的标志 0:小程序 1:小游戏
data_from int 数据来源 0:推荐数据 1:兜底数据

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
    "errno": "0",
    "errmsg": "succ",
    "tipmsg": "response is ok",
    "requeset_id": "2564900132",
    "timestamp": 1544800165,
    "data": {
        "app_list": [
            {
                "appkey": "Ly25vCMlwRr43vsi0p3UYO8ZkWF5KCGh",
                "name": "度城好物",
                "icon": "https://b.bdstatic.com/searchbox/mappconsole/image/20190320/9160281e-bf63-4d8b-bbc1-a5b7ded93d8e.jpg",
                "description": "度城好物，精选地方好物，感受城市温度",
                "schema": "baiduboxapp://swan/Ly25vCMlwRr43vsi0p3UYO8ZkWF5KCGh/?&_baiduboxapp=%7B%22from%22%3A%223103%22%2C%22ext%22%3A%7B%7D%7D&callback=_bdbox_js_275&upgrade=0",
                "frame_type": 0,
                "data_from": 0
            },
            {
                "appkey": "7z3zxAqQx2hQ3WBklIC8fnGOd631zZHm",
                "name": "百医健康",
                "icon": "https://b.bdstatic.com/searchbox/mappconsole/image/20190107/6fa3a6e1-2a94-4039-8e45-427860ad95fd.png",
                "description": "为用户带来更加真实可靠的医疗内容资源",
                "schema": "baiduboxapp://swan/7z3zxAqQx2hQ3WBklIC8fnGOd631zZHm/?&_baiduboxapp=%7B%22from%22%3A%223103%22%2C%22ext%22%3A%7B%7D%7D&callback=_bdbox_js_275&upgrade=0",
                "frame_type": 0,
                "data_from": 0
            }
        ],
        "list_num": 40,
        "has_more": 0,
        "base": "1000000"
    }
}

小程序排行榜

接口功能

获取宿主小程序排行榜

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/app/rank

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token

返回字段

Data Object说明

字段 类型 描述
app_list Array 小程序列表
title string 标题

List_num Array 说明

字段 类型 描述
appkey string 小程序key
name string 小程序名字
icon string 小程序图标
description string 小程序描述
schema string 小程序的调起 schema
data_from int 数据来源 0:推荐数据 1:兜底数据
feed_resouce_list Array 暂时不用
path String 暂时不用

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "errno": "0",
    "errmsg": "succ",
    "tipmsg": "response is ok",
    "requeset_id": "2564900132",
    "timestamp": 1544800165,
    "data": {
        "app_list": [
            {
                "appkey": "Ly25vCMlwRr43vsi0p3UYO8ZkWF5KCGh",
                "name": "度城好物",
                "icon": "https://b.bdstatic.com/searchbox/mappconsole/image/20190320/9160281e-bf63-4d8b-bbc1-a5b7ded93d8e.jpg",
                "description": "度城好物，精选地方好物，感受城市温度",
                "schema": "baiduboxapp://swan/Ly25vCMlwRr43vsi0p3UYO8ZkWF5KCGh/?&_baiduboxapp=%7B%22from%22%3A%223103%22%2C%22ext%22%3A%7B%7D%7D&callback=_bdbox_js_275&upgrade=0",
                "data_from": 0,}
        ],
        "title": “小程序排行榜”
    }
}

获取Feed物料接口

接口功能

批量获取 Feed 物料接口

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/material/search

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token
app_keys String 否 支持多个小程序 Appkey,使用英文逗号分隔多个建议 只使用一个。app_keys 不使用的时候不用传，最多支持20个
start_date String 否 创建的开始时间 20190216
end_date String 否 创建的结束时间 20190217，与start_date必须成对出现，如例子，会获取 createtime 在 2019年02月16日0点0分0秒至2019年02月17日0点0分0秒的数据
page_num Long 是 分页拉取当前第几页(从 1 开始计数)
page_size Long 是 每页获取最大数量，不能超过 100

返回字段

Data Object说明

字段 类型 描述
appList Array 物料列表
hasMore Int 是否还有下一页

List_Array_Item 说明

字段 类型 描述
mid int 物料 id
appKey string 小程序、小游戏 product_key
tags string 标签
images string 图片数组
cardStyle int card_style根据类型判断 有视频类1001 直播类1000和图文1002
createTime long 创建时间
feedSubType string feed的物料类型
feedType string feed的物料类型
getFrom string 来源 api提交：openApi 抓取：crawler
imageStyle int 小游戏图片类型 （大图 小图 竖图）
mappSubType int 小程序类型
mappType int 小程序类型
path string 落地路径
feedStatus int 物料流转状态
title string 物料title

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
{
    "errno":0,
    "msg":"success",
    "timestamp":1572852821,
    "data":{
        "appList":[
            {
                "appKey":"flFqXclepWs7RdugAszy9eERL7G5dS0I",
                "tags":"",
                "images":"[{\"url\":\"https://b.bdstatic.com/miniapp/resource/image/20191019/41620c58-ccd7-4c13-85d7-41e38053c3f0.jpg\",\"width\":1280,\"height\":720}]",
                "cardStyle":1001,
                "createTime":1571456752115,
                "feedSubType":"美食",
                "feedType":"生活",
                "getFrom":"crawler",
                "imageStyle":0,
                "mappSubType":1002,
                "mappType":1000,
                "path":"/pages/pb/pb?tid=6301392316",
                "feedStatus":3,
                "title":"吃了多年的牛肉，还是这种吃法最过瘾，一口一块好吃得停不下来！",
                "mid":"1512118734274080836"
            }
       ],
        "hasMore":1
    },
    "request_id":"be6555b8a8614aa8816a55ebf3ec720e"
}

阿拉丁子链信息

接口功能

获取阿拉丁子链信息

URL

https://openapi.baidu.com/rest/2.0/smartapp/osa/subchain/list

调用方式

GET

是否可重入

是

支持数据格式

JSON

参数说明

参数名 类型 必填 说明
union_sign String 是 签名，生成方式见签名说明
union_timestamp Long 是 时间戳，时间标准为 UTC，取当前请求时间
union_nocestr String 是 随机字符串，每次请求生成一个新的随机字符串，随机 串长度不能超过 64 位，可以有数字，字母，连接符-组成。
access_token String 是 access_token
app_key String 是 小程序 app_key
page_no String 是 页码
page_size String 是 每页数据量

返回字段

Data Object说明

字段 类型 描述
rows Array 子链列表
count int 数据总数，总共多少条
page_count int 页面总数，总共多少页

Row_Array_Item 说明

字段 类型 描述
id Int ID
appKey string 小程序appKey
appName string 小程序名字
customerId Int 商户ID
customerName string 商户名字
chainName string 子链标题
chainDesc string 子链描述
chainPath string 子链落地页路径
pathMd5 string 子链落地路径MD5
chainRank Int 子链排名
auditTime Int 子链审核时间
auditDesc string 子链审核描述
create_time Int 创建子链时间
update_time Int 更新子链时间

返回示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "errno": 0,
  "msg": "success",
  "timestamp": 1572839803,
  "data": {
    "rows": [
    {
      "id": 10093,
      "appId": 17490986,
      "appName": "哈尔滨和昕心理咨询",
      "customerId": 136466,
      "customerName": "哈尔滨和昕心理科技有限公司",
      "chainName": "联系我们",
      "chainDesc": "联系方式",
      "chainPath": "/yyf_baidu/pages/contact/contact",
      "pathMd5": "9d26cdfe077399af68a796a6de5a687d",
      "chainRank": 99,
      "createTime": 1571014356,
      "updateTime": 1571026488,
      "auditTime": 1571026487,
      "auditDesc": ""
    }],
    "count": 3, //数据总数，总共多少条
    "page_count": 2 //页面总数，总共多少页
  },
  "request_id": "fedd8b45a86f4522876d00bfd96b3a79"
}

返回状态码说明

参数说明

状态码(errno) 说明
0 请求成功
110 OpenAPI 校验不通过，参数无效
110 OpenAPI 校验不通过，AccessToken 失效
404 OpenAPI 校验不通过，请求路径无效
1001 参数错误
1002 无权限
1003 签名错误
1024 业务异常
1024 小程序不存在
20000 无 APP 操作权限
20001 授权异常
20002 授权异常
40000 小程序包不存在
50000 小程序没有权限授权
接入说明 消息通知说明
版权声明： 创作共用-署名-禁止演绎