# API IP 白名单
本文将介绍小程序、小游戏、公众号、服务号、微信小店、小店带货助手、第三方平台、视频号助手、联盟带货机构的 API IP 白名单配置方法。
注意:当前微信生态内多个业务需配置 API IP 白名单,详细的规则参考下文,每个业务均有细微区别。
# 1、小程序与小程序 IP 白名单
在小程序/小游戏业务中,分别有「API IP 白名单」和「代码上传 IP 白名单」两个配置,该两个配置的说明如下:
- API IP 白名单:开启后只有白名单内的 IP 才可以调用参数为 AppSecret 的接口,如获取接口调用凭据、获取稳定版接口调用凭据以及使用AppSecret重置API调用次数这三个接口。
- 代码上传 IP 白名单:白名单内的IP才可成功调用代码上传接口,具体会影响 miniprogram-ci 的使用。
# 操作路径
- 添加「IP白名单」 路径为:微信公众平台 - 开发管理 - 开发设置 - 开发者ID - IP白名单
- 添加「代码上传IP白名单」路径为:微信公众平台 - 开发管理 - 开发设置 - 小程序代码上传 - IP白名单
# 配置规则
API IP 白名单
- 一个小程序/小游戏支持配置 10个 API IP 白名单
- 支持具体 IP 以及 IP 段,如 172.0.0.1、172.0.0.*、172.0.0.1/24
- 不支持“IP:端口”形式
代码上传 IP 白名单
- 一个小程序/小游戏支持配置 10个代码上传 IP 白名单
- 支持具体 IP 以及 IP 段,如 172.0.0.1、172.0.0.*、172.0.0.1/24
- 不支持“IP:端口”形式
# 影响与后果
- 如果配置了 API IP 白名单,但是不按照要求调用参数为 AppSecret 的接口,则返回 40164 的报错,如
{"errcode":40164,"errmsg":"invalid ip 8.149.XXX.108 ipv6 ::ffff:8.149.XXX.108, not in whitelist rid: xxxxxxxx-xxxxxxxx-xxxxxxxx"} - 出现该问题,只需将 IP 添加至「IP白名单」即可
# 2、公众号与服务号 IP 白名单
公众号与服务号也支持「API IP 白名单」配置,具体说明以及配置规则如下:
- API IP 白名单:仅白名单中的 IP 才可调用公众号/服务号的服务端接口,即通过AppSecret 或者 access_token 服务端接口时,需将访问来源 IP 设置为 IP白名单。
- 配置规则:支持具体 IP 以及 IP 段,如 172.0.0.1、172.0.0.1/24(不支持 172.0.0.* 这种格式)
- 可支持配置多个
- 不支持“IP:端口”形式
# 操作路径
- 添加「IP白名单」 路径为:微信开发者平台 - 我的业务,然后点击公众号或者服务号进入详情页,然后前往「基础信息 - 开发信息」即可配置 API IP 白名单
# 影响与后果
- 如果配置了 API IP 白名单,但是不按照要求调用参数为 AppSecret 的接口,则返回 40164 的报错,如
{"errcode":40164,"errmsg":"invalid ip 8.149.XXX.108 ipv6 ::ffff:8.149.XXX.108, not in whitelist rid: xxxxxxxx-xxxxxxxx-xxxxxxxx"} - 出现该问题,只需将 IP 添加至「API IP 白名单」即可
# 3、小店带货助手 IP 白名单
小店带货助手也支持「API IP 白名单」配置,具体说明以及配置规则如下:
- API IP 白名单:开启后只有白名单内的 IP 才可以调用参数为 AppSecret 的接口。
- 若删除所有的IP,则默认关闭IP白名单。设置成功后十分钟生效。
- 配置规则:支持具体 IP 以及 IP 段,如 172.0.0.1、172.0.0.1/24(不支持 172.0.0.* 这种格式)
- 可支持配置多个
- 不支持“IP:端口”形式
# 操作路径
- 添加「IP白名单」 路径为:微信开发者平台 - 我的业务,然后点击带货助手进入详情页,然后前往「基础信息 - 开发信息」即可配置 API IP 白名单
# 影响与后果
- 如果配置了 API IP 白名单,但是不按照要求调用参数为 AppSecret 的接口,则返回 40164 的报错,如
{"errcode":40164,"errmsg":"invalid ip 8.149.XXX.108 ipv6 ::ffff:8.149.XXX.108, not in whitelist rid: xxxxxxxx-xxxxxxxx-xxxxxxxx"} - 出现该问题,只需将 IP 添加至「API IP 白名单」即可
# 4、微信小店 IP 白名单
微信小店也支持「API IP 白名单」配置,具体说明以及配置规则如下:
- API IP 白名单:开启后只有白名单内的 IP 才可以调用参数为 AppSecret 的接口。
- 若删除所有的IP,则默认关闭IP白名单。设置成功后十分钟生效。
- 配置规则:支持具体 IP 以及 IP 段,如 172.0.0.1、172.0.0.1/24
- IP 段仅支持 /8、/16、/24 网段,不支持其他网段
- 不支持“IP:端口”形式
- 最多可支持配置 200 个
# 操作路径
- 添加「IP白名单」 路径为:微信小店 - 服务市场 - 经营工具 - 自研
# 影响与后果
- 如果配置了 API IP 白名单,但是不按照要求调用参数为 AppSecret 的接口,则返回 40164 的报错,如
{"errcode":40164,"errmsg":"invalid ip 8.149.XXX.108 ipv6 ::ffff:8.149.XXX.108, not in whitelist rid: xxxxxxxx-xxxxxxxx-xxxxxxxx"} - 出现该问题,只需将 IP 添加至「API IP 白名单」即可
# 5、视频号助手 IP 白名单
视频号助手也支持「API IP 白名单」配置,具体说明以及配置规则如下:
- API IP 白名单:开启后只有白名单内的 IP 才可以调用参数为 AppSecret 的接口。
- 若删除所有的IP,则默认关闭IP白名单。设置成功后十分钟生效。
- 配置规则:支持具体 IP 以及 IP 段,如 172.0.0.1、172.0.0.1/24
- IP 段仅支持 /8、/16、/24 网段,不支持其他网段
- 不支持“IP:端口”形式
- 最多可支持配置 200 个
# 操作路径
- 添加「IP白名单」 路径为:视频号助手 - 直播 - 直播管理 - 开放能力 - 基础信息
# 影响与后果
- 如果配置了 API IP 白名单,但是不按照要求调用参数为 AppSecret 的接口,则返回 40164 的报错,如
{"errcode":40164,"errmsg":"invalid ip 8.149.XXX.108 ipv6 ::ffff:8.149.XXX.108, not in whitelist rid: xxxxxxxx-xxxxxxxx-xxxxxxxx"} - 出现该问题,只需将 IP 添加至「API IP 白名单」即可
# 6、第三方平台 IP 白名单
第三方平台也支持「API IP 白名单」配置,具体说明以及配置规则如下::
- API IP 白名单:仅白名单中的 IP 才可调用第三方平台的服务端接口,即通过component_secret、component_access_token 或者 authorizer_access_token 服务端接口时,需将访问来源 IP 设置为 IP白名单。
- 配置规则:仅支持具体 IP ,如 172.0.0.1(不支持 172.0.0.* 以及 172.0.0.1/24 这种格式)
- 最多可支持配置 100 个
- 不支持“IP:端口”形式
# 操作路径
- 添加「IP白名单」 路径为:微信开放平台 - 管理中心 - 第三方平台 - 详情 - 开发配置 - 开发资料
<img width="600px" src="https://testchu-7gy8occc8dcc14c3-1304825656.tcloudbaseapp.com/img%2Fmelody%2F20250629202012653.png"
# 影响与后果
- 如果配置了 API IP 白名单,但是不按照要求调用参数为 AppSecret 的接口,则返回 40164 的报错,如
{"errcode":61004,"errmsg":"access clientip is not registered requestIP: 119.147.XX.170 rid: xxxxxxxx-xxxxxxxx-xxxxxxxx"} - 出现该问题,只需将 IP 添加至「API IP 白名单」即可
# 7、其他业务说明
- 其他也尚未支持配置 IP 白名单,如移动应用、网站应用、多端应用等。后续会持续完善。