# auth.getPluginOpenPId

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

通过 wx.pluginLogin 接口获得插件用户标志凭证 code 后传到开发者服务器,开发者服务器调用此接口换取插件用户的唯一标识 openpid。

调用方式:

# HTTPS 调用

# 请求地址

POST https://api.weixin.qq.com/wxa/getpluginopenpid?access_token=ACCESS_TOKEN

# 请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
code string 通过 wx.pluginLogin 获得的插件用户标志凭证 code,有效时间为5分钟,一个 code 只能获取一次 openpid

# 返回值

# openpid

插件用户的唯一标识。

# 异常返回

# Object

JSON

属性 类型 说明
errcode number 错误码
errmsg string 错误信息

errcode 的合法值

说明 最低版本
1000 系统错误
1001 请求参数非法
1003 请求频率过快
1005 插件appid与数据不匹配
1007 openpid数据不存在
1022 json数据解析错误
45009 当日请求数量已达上限

# 返回值说明

如果调用成功,会返回插件用户 openpid。如果请求失败,会返回 JSON 格式的数据。

# 示例

请求

{
    "code": "0c2b206443ce0c23338f6cb4d1ec15a1af0b8bcddbff26510dda4b23a433c391"
}

返回

{
 "errcode": 0,
 "errmsg": "ok",
 "openpid": "GACo74wkDIkDzEhkwRwgjGt1pqlk",
}

# 云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

# 接口方法

openapi.auth.getPluginOpenPId

需在 config.json 中配置 auth.getPluginOpenPId API 的权限,详情

# 请求参数

属性 类型 默认值 必填 说明
code string 通过 wx.pluginLogin 获得的插件用户标志凭证 code,有效时间为5分钟,一个 code 只能获取一次 openpid

# 返回值

# openpid

插件用户的唯一标识。

# 异常

# Object

JSON

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本

# 示例

请求

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.auth.getPluginOpenPId({
        "code": '0c2b206443ce0c23338f6cb4d1ec15a1af0b8bcddbff26510dda4b23a433c391'
      })
    return result
  } catch (err) {
    return err
  }
}

返回

{
 "errcode": 0,
 "errmsg": "ok",
 "openpid": "GACo74wkDIkDzEhkwRwgjGt1pqlk",
}