跳转到: 导航, 搜索

JS SDK

JS SDK for OAuth2.0是线上JS SDK的升级版本(V1版JS SDK),它较之前版本有较大改变:

  • 1、它去掉了部署在第三方的xd.html跨域文件,使开发者开发使用更加简单方便;
  • 2、Appkey的传递方式由原来的json方式改变为通过参数传递方式;
  • 3、为兼容之前JSSDK,该版JSSDK的命名空间由原来的WB改变为WB2;
  • 4、该版本将Js widget内置其中,用户无需再去单独引用JS和CSS,只需调用相应的js widget方法即可;
  • 5、支持通过版本号调用js widget,以便不同开发者不同的需要;


下面我们来一起体验一下这些特性。你也可以浏览微博JS SDK的官方支持站,查看更加细致的文档。


开发指南

如果你没有AppKey请先在开放平台网站点击网站接入添加新网站,申请入口


1、网站接入绑定域名

为了保证你的应用或网站的安全,在使用Weibo JS SDK时,需要你在应用信息页面为该应用选定绑定域名功能,并绑定你的域名,我们将以此域名来判定Weibo JS SDK API请求来源的合法性,不合法的请求将被拒绝。


绑定域名的操作可以在应用创建页面及编辑页面完成。选择“绑定域名”,填入域名提交即可。


2、增加命名空间

在您页面的HTML标签中增加XML命名空间。

HTML
<html xmlns:wb="http://open.weibo.com/wb">


3、引用JS SDK文件

在你的页面部署wb.js,同时,如果你的页面编码不是UTF-8,请添加charset="utf-8"属性。

HTML
<script src="http://tjs.sjs.sinajs.cn/open/api/js/wb.js?appkey=YOUR APPKEY" type="text/javascript" charset="utf-8"></script>

如果你的应用处于开发调试过程,建议使用JSSDK的调试模式,开启调试模式,只需增加一个参数debug=true即可,JSSDK会在浏览器的控制台或自带的JS调试工具中输出相关的日志信息,以方便调试。

HTML
<script src="http://tjs.sjs.sinajs.cn/open/api/js/wb.js?appkey=YOUR APPKEY&debug=true" type="text/javascript" charset="utf-8"></script>


4、开始使用JS SDK

调用JSSDK访问API接口。

Javascript
WB2.anyWhere(function(W){
    W.parseCMD("/users/show.json", function(sResult, bStatus){
        try{
            //to do something...
        }catch(e){}
    },{
        uid: '123456789'
    }{
        method: 'get'
    });
});

部署微博组件。

HTML
<wb:share-button type="button" size="middle"> </wb:share-button>


JS SDK公开方法及说明

JS SDK公开方法。


WB2.login(callback)
微博登录认证功能。
示例
Javascript
WB2.logout(function() {
    //callback function
});
参数说明
参数名称 类型 默认值 是否必选 说明描述
callback Function 登录后的回调函数。


WB2.logout(callback)
退出微博登录功能。
示例
Javascript
WB2.logout(function() {
    //callback function
});
参数说明
参数名称 类型 默认值 是否必选 说明描述
callback Function 退出登录后的回调函数。


WB2.checkLogin()
检测微博登录状态,已登录返回true,未登录返回false。
示例
Javascript
var status = WB2.checkLogin();
alert(status);


WB2.anyWhere(callback)
第三方与微博API进行数据交互及采用Js方式调用内置微博组件的入口函数。
示例
Javascript
WB2.anyWhere(function(W){
    //数据交互
    W.parseCMD(...);
     
    //调用微博组件
    W.widget.hoverCard(...);
    W.widget.followButton(...);
    ...
});
参数说明
参数名称 类型 默认值 是否必选 说明描述
callback Function 回调函数,必需指定一个形参W,可以通过形参调用parseCMD读取开放平台API接口或者使用微博组件。具体见parseCMD及JS调用微博组件的说明。


W.parseCMD(uri, callback, args, opts)
第三方与开放平台API接口进行数据请求的函数,必须在WB2.anyWhere中通过W对象调用。
示例
Javascript
WB2.anyWhere(function(W){
    //数据交互
    W.parseCMD('/users/show.json', function(oResult, bStatus) {
        if(bStatus) {
            //to do something...
        }
    }, {
        screen_name : '姚晨'
    }, {
        method : 'get',
        cache_time : 30
    });
});
参数说明
参数名称 类型 默认值 是否必选 说明描述
uri String 传递给API接口的命令URI,如“/users/show.json”、“statuses/public_timeline.json”,请见 API文档
callback Function 请求API接口返回数据后的回调函数。默认返回两个参数,oResult:接口返回数据(JSON格式);bStatus:接口返回状态,true - 接口正常、false - 接口异常。
args Object 发起数据请求时,传递给API接口的参数对象。如“users/show.json”接口中的,uid、screen_name等。JSON格式。
opts Object {method: 'post', cache_time: 0} 请求API接口的时候的附加属性,method:请求类型,默认为post;cache_time:数据缓存时间,默认为0,单位为秒。JSON格式。


JS组件说明及示例

JS 组件的使用方法及示例。JS 组件有WBML、和HTML+JS两种部署方法。


微博登录按钮
第三方与微博进行连接登录的按钮,可实现登录与退出功能。
示例
HTML
<div id="wb_connect_btn"></div>
Javascript
WB2.anyWhere(function (W) {
    W.widget.connectButton({
        id: "wb_connect_btn",
        type: '3,2',
        callback: {
            login: function (o) { //登录后的回调函数
                alert("login: " + o.screen_name)
            },
            logout: function () { //退出后的回调函数
                alert('logout');
            }
        }
    });
});
WBML
<wb:login-button type="3,2" onlogin="login" onlogout="logout"></wb:login-button>


微博关注按钮
关注按钮可以部署在任何支持HTML的网页。用户在这些网页点击关注按钮,就可以快速成为你的微博粉丝; 关注按钮会自动判断与用户的关系,对于已关注用户,将显示其微博动态。
示例
HTML
<div id="wb_follow_btn"></div>
Javascript
WB2.anyWhere(function(W){
    W.widget.followButton({
        'nick_name': '姚晨',  //用户昵称
        'id': "wb_follow_btn",
        'show_head' : true, //是否显示头像
        'show_name' : true, //是否显示名称
        'show_cancel': true //是否显示取消关注按钮
    });
});
WBML
<wb:follow-button uid="1052981072" type="red_4">关注按钮</wb:follow-button>


微博名片
微博名片组件可在一段纯文本中,自动识别@用户名,添加用户名片功能。鼠标移动到"@用户名"上时,浮出一个展示用户信息的名片,名片中同时带有微博关注按钮功能。支持单独处理及批量处理两种方式。
示例
HTML
<a id="wb_card_alone" wb_screen_name="woiweb" href="#">woiweb</a>
Javascript
WB2.anyWhere(function(W){
    W.widget.hoverCard({
        id : "wb_card_alone"
    });
});


微博发布器
在您的博客、网站或其他支持HTML的位置嵌入一段微博发布器对应的代码,不仅能让用户直接发微博,您还可以在发布器中预制文案及图片。
示例
HTML
<button type="button" id="wb_publish"></wb:button>
Javascript
WB2.anyWhere(function(W){
    W.widget.publish({
        'id' : 'wb_publish',
        'default_text' : '预置方案 & \r\n我可以换行.',
        'callback' : function(o) {
            //do something...
        }
    });
});
WBML
<wb:publish></wb:publish>


微博好友选择器
包括相互关注、我的粉丝、我关注的人三个标签,标签可配,支持@联想输入功能,可快速选择所需好友,选择后点击确定即可得到已选择的好友的信息。
示例
HTML
<button id="wb_selector" type="button"></button>
Javascript
WB2.anyWhere(function(W){
    W.widget.selector({
        id : "wb_selector"
    });
});



文档更新时间: 2014-07-17