SDK 接入演示

在你的网站中快速接入微信订阅号认证

方式一:NPM 安装

# 安装 SDK
npm install wx-auth-sdk
import { WxAuth } from 'wx-auth-sdk';
import 'wx-auth-sdk/dist/style.css';

// ✅ 零配置接入(推荐)
WxAuth.init({
  // 什么都不用配置,SDK 会自动获取 siteId、apiBase 和公众号信息
  onVerified: (user) => {
    console.log('认证成功', user);
  },
  // onClose: () => { ... }  // 可选认证时使用
});

方式二:CDN 引入

<!-- 引入样式和脚本 -->
<link rel="stylesheet" href="https://unpkg.com/wx-auth-sdk/dist/wx-auth.css">
<script src="https://unpkg.com/wx-auth-sdk/dist/wx-auth.umd.js"></script>

<script>
  WxAuth.init({
    // ✅ 零配置,所有参数自动获取
    onVerified: (user) => {
      console.log('认证成功', user);
    },
    // onClose: () => { ... }  // 可选认证时使用
  });
</script>

配置说明

siteId站点唯一标识(可选,自动获取),从 document.referrer 或当前域名自动提取
apiBase后端 API 地址(可选,已有默认值),当前为 https://wx-auth.shenzjd.com
required是否必须认证(可选,默认 true
onVerified验证成功回调(推荐配置
onClose用户关闭弹窗回调(可选,仅在 required=false 时触发)

⚠️ 注意:wechatNameqrcodeUrl 无需配置,自动从后端获取,接入方配置也无效(统一使用"神族九帝"公众号)。

✅ 推荐:所有参数都无需手动配置,只需调用 WxAuth.init() 即可实现零配置接入!

API 方法

WxAuth.init(options)

初始化 SDK,自动检测 Cookie 并静默认证

WxAuth.requireAuth()

手动触发认证流程,返回 Promise<boolean>

WxAuth.close()

关闭认证弹窗

自动配置获取

wechatName、qrcodeUrl 自动从 /api/sdk/config 获取

实时测试

点击下方按钮测试 SDK 认证流程(使用 demo siteId):

微信订阅号认证 SDK v1.1.0 | 零依赖 | < 12 KB