Giter Club home page Giter Club logo

wechat-oauth-promise's Introduction

Wechat OAuth Promise

Wechat OAuth for ES6 with Promise support。 微信公共平台OAuth接口API SDK

OAuth2.0网页授权,使用此接口须通过微信认证,用户在微信中访问公众号的第三方网页, 公众号开发者可以通过此接口获取当前用户基本信息。详细信息:官方文档

Usage

初始化

import WechatOAuthPromise from 'wechat-oauth-promise';
let oauth = new WechatOAuthPromise('your appid', 'your secret', (openid, token) => {
  // 自定义保存AccessToken方法
}, (openid) => {
  // 自定义获取AccessToken方法
});

接口默认提供保存和获取AccessToken的方法

// default saveToken function
async saveToken(openid = '', token) {
  if (openid === '') {
    let error = new Error('Openid can\'t allow empty');
    return Promise.reject(error);
  }

  let fileName = `${openid}-access-token.txt`;
  let result = await writeFile(fileName, JSON.stringify(token)).catch((error) => {
    return Promise.reject(error);
  });
  return Promise.resolve(result === 'Succeed');
}

// default getToken function
async getToken(openid = '') {
  if (openid === '' || !openid) {
    let error = new Error('Openid can\'t allow empty');
    return Promise.reject(error);
  }

  let fileName = `${openid}-access-token.txt`;
  let data = await readFile(fileName).catch((error) => {
    return Promise.reject(error);
  });
  return Promise.resolve(JSON.parse(data));
}

引导用户

生成引导用户点击的URL

// scope 默认为 snsapi_base
let url = oauth.getAuthorizeURL('redirect_uri', 'state', 'scope');

获取AccessToken和Openid

用户点击上步生成的URL后会被重定向到上步设置的 redirect_uri,并且会带有code参数, 使用code换取access_token和用户的openid

// 如果发生错误,token = undefined
let token = await oauth.getAccessToken(code).catch((error) => {
  // 处理错误
});

获取用户信息

如果生成引导用户点击的URL中scope参数值为snsapi_userinfo, 可以使用getAccessToken获取到的openid请求获取用户详细信息

// 如果发生错误,userInfo = undefined
let userInfo = await oauth.getUserInfo(token.openid).catch((error) => {
  // 处理错误
});

License

The MIT license.

wechat-oauth-promise's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

jealee3000

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.