YunGouOS 微信登录授权接口文档

本文介绍 YunGouOS 开放平台的微信登录授权接口，帮助开发者快速实现微信 OAuth 授权功能，获取用户授权信息。

接口概述

YunGouOS 提供微信登录授权接口 getOauthUrl，返回授权 URL，客户端需要输出这个 URL 让用户重定向到微信授权页面。授权结束后，系统会携带 code 到您传入的返回地址上，在您的授权返回地址中获取该 code，通过调用查询授权信息接口来查询用户授权数据。

接口地址

POST https://api.wx.yungouos.com/api/wx/getOauthUrl

请求参数

参数名	参数类型	是否必填	描述
mch_id	String	是	微信支付商户号或 YunGouOS 商户 ID
callback_url	String	是	授权结束后返回的地址
type	String	否	授权类型，不传默认 mp-base。mp-base：基础授权，不会有授权页面，用户无感知，只可获取 openid；open-url：微信 PC 端扫码登录 url
params	String	否	额外参数，授权结束后可通过查询接口查询。注意：该参数需要是 JSON 字符串
sign	String	是	数据签名（见签名算法文档）

返回结果

参数名	参数类型	是否必填	描述
code	Int	是	状态【0：成功；1：失败】
data	String	是	授权 url
msg	String	是	消息

返回示例

json

{
  "msg": "获取成功，请重定向到该地址完成授权",
  "code": 0,
  "data": "https://open.weixin.qq.com/connect/oauth2/authorize?appid=wx61aebce585361b4a&redirect_uri=https://api.wx.yungouos.com/callback/wxmp/oauth&response_type=code&scope=snsapi_userinfo&state=A85D740CEA274BC683C7F6B8DC1D77CC#wechat_redirect"
}

注意事项

禁止滥用：该接口禁止业务未发生时调用，比如网站一打开就调用该接口，系统识别该种情况会拉黑服务器 IP。
Code 有效期：授权回调后 code 有效期 5 分钟，必须在 5 分钟内调用【查询授权信息】接口获取结果，过期后需要重新授权。
授权类型区别：当 type 参数为 open-url 时，返回的链接需要在 PC 端进行重定向，其他参数则在微信内进行重定向。

字节笔记本