一键设置微信头像，官方头像填充 API 玩法详解

前端

2023-07-25 22:39:54

微信小程序头像填充 API：快速获取用户头像和用户名

随着微信小程序生态系统的不断完善，微信官方推出了一系列新能力，帮助开发者简化开发流程并提升用户体验。其中，微信小程序头像填充 API 备受关注，它为开发者提供了便捷的方式来获取用户头像和用户名，增强了小程序的交互性和用户粘性。

微信小程序头像填充 API 的优势

相较于传统的getUserProfile 接口，微信小程序头像填充 API 拥有以下优势：

更简单易用： 仅需调用一个 API 即可获取头像和用户名，无需复杂的参数校验和签名计算。
更安全可靠： 由微信官方提供，保障数据的安全性。
更兼容： 兼容所有小程序版本，无需考虑兼容性问题。

如何使用微信小程序头像填充 API

1. 申请权限

在使用 API 之前，需要申请相应权限：

登录微信开放平台官网 。
点击开发 > 权限中心 > 获取权限 。
找到头像填写 并点击申请。
填写申请表并提交。

2. 集成头像填充 SDK

申请通过后，可在小程序代码中引入头像填充 SDK ：

const util = require('@/utils/util')

3. 调用 API

使用util.getAvatarInfo 方法调用 API：

util.getAvatarInfo().then(res => {
  console.log(res)
})

4. 处理返回结果

API 返回结果为一个 JSON 对象，包含以下字段：

avatarUrl： 头像 URL
nickName： 用户名
gender： 性别（0：未知、1：男、2：女）
city： 所在城市
province： 所在省份
country： 所在国家

5. 处理错误

API 可能返回以下错误：

ERR_AUTH_DENIED： 用户拒绝授权
ERR_NETWORK： 网络错误
ERR_TIMEOUT： 超时
ERR_INTERNAL： 内部错误

根据不同错误类型进行相应处理。

微信小程序头像填充 API 的常见问题

1. 使用限制

每个小程序每天限调用 1000 次。
每个用户每天限调用 10 次。

2. 错误码

API 可能返回以下错误码：

ERR_AUTH_DENIED： -3
ERR_NETWORK： -2
ERR_TIMEOUT： -1
ERR_INTERNAL： 0

3. 调用示例

util.getAvatarInfo().then(res => {
  if (res.errMsg === 'getAvatarInfo:ok') {
    console.log('获取头像和用户名成功')
    console.log(`头像 URL：${res.avatarUrl}`)
    console.log(`用户名：${res.nickName}`)
  } else {
    console.log(`获取头像和用户名失败：${res.errMsg}`)
  }
})