node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

node-easywechat

EasyWechat for Node.js

注:本项目任在开发阶段,不建议投入生产环境

EasyWechat 是一个由 安小超 大神用 PHP 开发的开源的微信非官方 SDK。其功能强大,使用方便,个人一直很喜欢,所以近日将其在 Node.js 上实现。本人会尽量还原其配置项以及接口的调用方式,但毕竟语言环境不同,具体的实现方式会有些许差别,还请各位开发者见谅。

注:虽然也使用了 EasyWechat 这个名称,但是和 安小超 大神没有任何关系,请各位开发者不要因使用本包产生的疑惑而去打扰大神,如有疑问请在本项目中提 issue,谢谢~

安装

npm install -S node-easywechat

使用示例

node-easywechat-demo

配置项示例

{
  // 微信公众号的 app key
  appKey: '',
  // 微信公众号的 app secret
  appSecret: '',
  // 微信公众号的 token
  token: '',
  // 微信公众号的 token
  aesKey: '',
 
  // access_token 的缓存名称
  access_token_cache_key: 'NODE_EASYWECHAT_ACCESS_TOKEN',
 
  // jssdk 的缓存名称
  jssdk_cache_key: 'NODE_EASYWECHAT_JSSKD_TICKET',
 
  // 缓存驱动,可选值:memory(内存存储)、file(文件存储),默认:memory
  cache_driver: 'file',
  // 缓存以文件存储时,需要的配置项
  cache_options: {
    path: './cache/', // 文件存储目录(请确保该目录有读写权限)
    fileMode: 0o666,  // 文件权限
    ext: '.cache'     // 文件扩展名
  },
  // // 自定义缓存驱动
  // // 您需要实现一个继承 EasyWechat.Cache.CacheInterface 的缓存驱动类
  // // 实例化以后赋值给 cache 选项即可
  // cache: customCacheDriver
 
  // 网页授权认证
  oauth: {
    // 网页授权类型
    scope: 'snsapi_userinfo',
    // 网页授权回调地址,完整的URL
    redirect: 'http://node-easywechat.hpyer.cn/wxlogin/callback'
  }
}

基本使用

  • 网页授权登录
  • JSSDK
  • 服务端
  • 消息
  • 多客服消息转发
  • 事件
  • 群发消息
  • 模板消息
  • 用户
  • 用户标签
  • 用户组
  • 小程序
  • 素材管理
  • 菜单
  • 支付
  • 企业支付
  • 红包
  • 卡券
  • 小店
  • 门店
  • 客服
  • 数据统计与分析
  • 二维码
  • 短网址
  • 语义理解
  • 自动回复
  • 开放平台

自定义

  • Access Token
  • 缓存