API文档

了解如何集成江渔开放平台的微信授权登录功能

介绍

江渔开放平台提供基于微信开放平台的授权登录解决方案,支持PC端和移动端统一的授权体验。通过我们的API,您可以轻松地在自己的应用中集成微信登录功能。

主要特点:

  • PC端自动展示二维码扫码登录
  • 移动端自动跳转到微信授权页面
  • 统一的用户信息和授权流程
  • 安全可靠的用户信息处理

快速开始

要使用江渔开放平台的微信授权登录功能,您需要完成以下步骤:

1. 注册开发者账号

在江渔开放平台注册一个开发者账号,并创建您的应用。

2. 获取应用凭证

创建应用后,您将获得以下凭证:

  • AppID:应用的唯一标识
  • AppSecret:应用的密钥,请妥善保管

3. 配置回调URL

在应用设置中,配置授权回调URL,用于接收授权结果。

4. 集成授权流程

根据下面的API文档,在您的应用中集成微信授权登录功能。

授权流程

微信授权登录的流程如下:

  1. 用户访问您的应用,点击"微信登录"按钮
  2. 应用将用户重定向到江渔开放平台的授权页面
  3. 根据用户设备类型:
    • PC端:显示微信二维码,用户使用微信扫码
    • 移动端:跳转到微信授权页面,用户点击确认授权
  4. 用户授权后,微信将用户重定向回您配置的回调URL
  5. 您的应用通过回调URL中的授权码获取用户信息
  6. 完成登录流程,为用户创建会话
授权流程图

API参考

授权API

获取授权URL

请求URL: https://open.jiangyu.net.cn/wechat/auth

请求方式: GET

请求参数:

参数名 必选 类型 说明
redirect_url string 授权成功后的回调地址,需要进行URL编码
state string 自定义状态参数,会在回调时原样返回
// 示例:获取授权URL
const authUrl = 'https://open.jiangyu.net.cn/wechat/auth?redirect_url=' + encodeURIComponent('https://your-app.com/callback');
window.location.href = authUrl;

用户信息API

获取用户信息

请求URL: https://open.jiangyu.net.cn/api/user/info

请求方式: GET

请求头: 需要包含授权令牌 Authorization: Bearer {access_token}

返回示例:

{
  "code": 0,
  "message": "success",
  "data": {
    "openid": "OPENID",
    "nickname": "用户昵称",
    "sex": 1,
    "province": "广东",
    "city": "深圳",
    "country": "中国",
    "headimgurl": "https://thirdwx.qlogo.cn/mmopen/xxx",
    "unionid": "UNIONID"
  }
}

错误码

错误码 说明
40001 无效的授权码
40002 无效的访问令牌
40003 访问令牌已过期
40004 缺少必要参数
50001 服务器内部错误

SDK下载

我们提供以下语言的SDK,方便您快速集成:

常见问题

当授权失败时,我们会将用户重定向到您配置的回调URL,并附加错误信息。您可以根据错误码进行相应处理,如提示用户重新授权或联系客服。

授权令牌的有效期为7天。您可以使用刷新令牌来获取新的授权令牌,刷新令牌的有效期为30天。

对于移动应用,您可以使用我们提供的移动SDK,或者通过WebView加载授权页面。我们的授权系统会自动检测设备类型,并提供适合的授权方式。