# 小店获取关联小程序信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:v3_getwxainfo
通过该接口可获取关联的小程序信息。
原有的接口「设置关联小程序信息」和「删除关联小程序信息」已经停用,改为小店电脑管理端操作。详见文档 开发流程 中的“测试上线流程”部分
注意:小店 API 请使用小店身份,即小店的access_token调用
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/channels/ec/vip/v3/wxa/info/get?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代微信小店商家调用。第三方服务商调用模式介绍
该接口所属的权限集 id 为:186
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代微信小店商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token(微信小店商家)、authorizer_access_token(服务商代调用) |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| wxa_appid | string | 关联的小程序appid |
| info | object | 关联小程序信息 |
| state | number | 状态,1:上线,2:未上线,3:上线前测试状态 说明:状态为2、3时,只有白名单用户可以在小店看到会员入口。 |
# Res.info Object Payload
关联小程序信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| paths | object | 小程序会员信息 |
| whitelist_openids | array | 小程序测试白名单用户openid列表 |
| display_info | object | 下单页权益 |
# Res.info.paths Object Payload
小程序会员信息
| 参数名 | 类型 | 说明 |
|---|---|---|
| register_path | string | 小程序会员注册页面路径 |
| rights_path | string | 小程序会员权益页面路径 |
# Res.info.display_info Object Payload
下单页权益
| 参数名 | 类型 | 说明 |
|---|---|---|
| order_page_display | number | 下单页权益展示开关,1为开,2为关 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/channels/ec/vip/v3/wxa/info/get?access_token=ACCESS_TOKEN
返回示例
{
"errcode": 0,
"errmsg": "ok",
"wxa_appid": "wxxxxxxxxxxxxxxxxx",
"info": {
"paths": {
"register_path": "main/register/path",
"rights_path": "main/rights/path"
},
"whitelist_openids": [
"openid_1",
"openid_2"
],
"display_info": {
"order_page_display": 0
}
},
"state": 0
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 1 | 参数异常 |
| 2 | 小店没绑定小程序 |
# 7. 适用范围
本接口支持「微信小店」账号类型调用。其他账号类型如无特殊说明,均不可调用。