bLogin

来自于:AC模块工作室立即使用

概述

模块封装了百度OAuth相关SDK,OAuth2.0(开放授权)是一个开放标准,用户授权后,第三方应用无需获取用户的用户名和密码就可以访问该用户在某一网站上存储的私密的资源(如照片,视频,联系人列表)。

Access Token:用户身份验证和授权的凭证。第三方应用在调用百度开放API之前,首先需要获取Access Token。

使用本模块前需要先到百度开发者中心注册账号并创建应用。

百度OAuth相关文档

android注意项

为确保验证授权过程的安全,开发者必须在开发者中心预先注册应用所在的域名或URL,参考链接

initBaiduLogin

初始化Baidu SDK

initBaiduLogin({param})

params

apiKey:

  • 类型:字符串
  • 默认值:无
  • 描述:应用的API Key

appId:

  • 类型:字符串
  • 默认值:无
  • 描述:应用的App ID

示例代码

var demo = api.require('bLogin');
demo.initBaiduLogin({
        apiKey : '7TjGqkwAU5rQPcC6LKGMjpKd',
        appId : '2014185'
    });

补充说明

使用此模块,必须先用initBaiduLogin初始化

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

isUserTokenValid

判断用户的授权状态

isUserTokenValid(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
     valid : true                  //布尔类型;是否有效
}

示例代码

var demo = api.require('bLogin');
demo.isUserTokenValid(function(ret) {
                if (ret) {
                    alert(JSON.stringify(ret));
                  }
              });

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

authorize

用户登录,进行授权

authorize(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
   state : 'success'    //字符串类型;授权是否成功
       // 取值范围:
       // 'success' : 授权成功
       // 'cancel' : 授权取消(由于百度SDK的限制,android不支持此字段,会以Toast形式弹出)
       // 'error' : 发生错误
    accessToken : ''    //字符串类型;令牌,当state为 success时返回此字段
    errorDesc : ''    //字符串类型;错误描述,当state为 error时返回此字段
}

示例代码

var demo = api.require('bLogin');
demo.authorize(function(ret) {
                   if (ret) {
                   alert(JSON.stringify(ret));
                   }
                   });

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

smsAuthorize

用户短信授权

smsAuthorize(callback(ret))

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
   state : 'success'    //字符串类型;授权是否成功
       // 取值范围:
       // 'success' : 授权成功
       // 'cancel' : 授权取消
       // 'error' : 发生错误
    accessToken : ''    //字符串类型;令牌,当state为 success时返回此字段
    errorDesc : ''    //字符串类型;错误描述,当state为 error时返回此字段
}

示例代码

var demo = api.require('bLogin');
demo.smsAuthorize(function(ret) {
                   if (ret) {
                   alert(JSON.stringify(ret));
                   }
                   });

可用性

iOS系统

可提供的1.0.0及更高版本

userRegister

用户注册

userRegister()

示例代码

var demo = api.require('bLogin');
demo.userRegister();

可用性

iOS系统

可提供的1.0.0及更高版本

apiRequest

调用Open API方法

apiRequest({param},callback(ret))

params

url:

  • 类型:字符串
  • 默认值:无
  • 描述:请求的url

httpMethod:

  • 类型:字符串
  • 默认值:'GET'
  • 描述:(可选项)发送请求的方法
  • 取值范围:
    • 'GET'
    • 'POST'

params:

  • 类型:JSON对象
  • 默认值:不传
  • 描述:(可选项)发送请求的参数

callback(ret)

ret:

  • 类型:JSON对象
  • 内部字段:
{
   state : 'success'    //字符串类型;请求是否成功
       // 取值范围:
       // 'success' : 请求成功
       // 'error' : 发生错误
    results : [{},{},...]    //数组类型;请求结果,当state为 success时返回此字段(android不是数组,就是一个JSON字符串)
    errorDesc : ''    //字符串类型;错误描述,当state为 error时返回此字段
}

示例代码

var demo = api.require('bLogin');
demo.apiRequest({
            url : 'https://openapi.baidu.com/rest/2.0/passport/users/getLoggedInUser',
                },function(ret) {
                if (ret) {
                    alert(JSON.stringify(ret));
                }
            });

可用性

iOS系统,android系统

可提供的1.0.0及更高版本

currentUserLogout

用户登出

currentUserLogout()

示例代码

var demo = api.require('bLogin');
demo.currentUserLogout();

可用性

iOS系统,android系统

可提供的1.0.0及更高版本