UMS-SDK

v1-doc

installation

npm install @gaoding/ums-sdk --save

init

const Ums = require('@gaoding/ums-sdk');
const ums = new Ums(options);

• Options parameters
  • name 应用名称
  • version 应用版本
  • appid 应用appid
  • appsecret 应用密钥

methods

实例方法

注册

const result = await ums.register(ctx);

• ctx.request.body
  • guest_token 游客token, 注册游客必须此参数
  • code 短信验证码
  • mobile 手机号
  • password 密码
  • nick 昵称
  • avatar 头像url
  • mobile_area_code 国家手机区号
  • source
• result
  • User model

获取阿里oss-token

const result = await ums.oss(ctx);

• ctx.request.body
  • key 文件key
  • file_type 默认image

获取注册短信验证码

const result = await ums.registerSms(ctx);

• ctx.request.body
  • type 验证码类型，取值有['find_password', 'register']
  • mobile 手机号

获取重新绑定手机号验证码

const result = await ums.rebindSms(ctx);

• ctx.request.body
  • mobile 新手机号
  • password 用户密码

获取oauth-access-token

const result = await ums.oauthLogin(ctx);

• ctx.request.body
  • grant_type oauth 请求的model类型，取值有 ['password', 'refresh_token', 'authorization_code']
  • client_id oauth 的客户端标识
  • client_secret oauth 的客户端密钥
  • [code] 授权码，grant_type=authorization_code 时需要
  • [redirect_uri] 获取authorization_code时的重定向uri，grant_type=authorization_code 时需要
  • [refresh_token] 预刷新token， grant_type=refresh_token 时需要
  • [username] grant_type=password 时需要
  • [password] grant_type=password 时需要
• result
  • accessToken 访问凭证
  • accessTokenExpiresAt 凭证失效时间
  • refreshToken 预刷新token
  • refreshTokenExpiresAt 预刷新token失效时间
  • scope token访问空间

销毁oauth-token

const result = await ums.revoke(ctx);

• ctx.request.body
  • token_type_hint token类型 ['accessToken', 'refreshToken']
  • token token_type_hint=accessToken时，传入客户端的accessToken值，token_type_hint=refreshToken时，传入客户端的refreshToken值
• result
  • code 200, 请求成功时返回

获取登录用户的个人信息

const result = await ums.getUserInfo(ctx);

• ctx.request.header
  • Authorization Bearer ${accessToken}, Bearer是固定格式
• result
  • User model

游客登录

const result = await ums.guestLogin(ctx);

• ctx.query || ctx.request.body
  • guest_token 游客凭证
  • client_id 客户端标识
  • client_secret 客户端密钥
• result
  • accessToken 访问凭证
  • accessTokenExpiresAt 凭证失效时间
  • refreshToken 预刷新token
  • refreshTokenExpiresAt 预刷新token失效时间
  • scope token访问空间