Weibo-JS
目录 |
概述
新浪微博Javascript SDK简称JS-SDK,包含两部分内容,本页描述基础SDK的相关信息,另外Javascript SDK Widget页面将对SDK包中的Widget部分进行细致的说明。
为了使您更好的了解JS-SDK,我们制作了范例。您可以自由查看,测试。
应用信息修改
为了保证您的应用的安全,在您使用JS-SDK时,需要您在应用信息页面为该应用绑定一个域名,我们将以此域名来判定JS-SDK API请求的合法性,不合法的请求将被拒绝。
绑定域名的操作可以在应用创建页面及编辑页面完成,具体如图:
some image.
创建跨域文件
如需使用Javacript SDK(JS-SDK),你需要在服务器上放置新浪提供的跨域文件
此文件(xd.html)需要被放置在你的站点域名下的某个路径,如 http://yourdoman.com/xd.html ,并保证此URL可用。
引用JavaScript文件
在页面顶端加入如下代码
<script type="text/javascript" src="http://js.wcdn.cn/t3/platform/js/api/wb.js" charset="utf-8" ></script>
初始化JavaScript Client
在页面的</body>后,加入下面的初始化代码。
<script type="text/javascript"> WB.core.load(['connect', 'client'], function() { var cfg = { key: 'API_KEY', xdpath: '跨域文件url(http://yourdomain.com/xd.html)' }; WB.connect.init(cfg); WB.client.init(cfg); }); </script>
JavaScript SDK 接口
登陆
WB.connect.login(function() { //callBack function });
退出
WB.connect.logout(function() { //callBack function });
checkLogin
/* * 检查登录情况 * @return {Boolean} 是否已经使用OAuth登录,已登录返回true,未登录返回false */ WB.connect.checkLogin();
waitReady
/** * 检查登录情况,如果登录则执行函数,否则把函数缓存起来 * @param {Function} oFunc 函数引用 * @param {Boolean} bStart 是否插入到最开始位置 */ WB.connect.waitReady(oFunc, bStart);
loginReady
/** * 登录完毕后续的处理动作,会存储下anywhereToken便于下次调用 * 执行堆栈中的函数队列 * 关闭当前窗口 */ WB.connect.loginReady();
命令解析
/** * @param {String} sMethod 传递给API的命令URI * @param {Function} oCallBack API返回数据后的回调函数 * @param {Object} oArgs 传递给API的参数对象 * @param {Object} oOpts 请求API的时候的类型 **/ WB.connect.parseCMD(sMethod, oCallBack, oArgs, oOpts);
范例
获取评论列表
WB.client.parseCMD( "/statuses/comments.json", function(sResult, bStatus) { if(bStatus == true){ alert(sResult); } }, { userid : 12345678 }, { method: 'post' } );
根据微博ID和用户ID得到单条微博
sMethod "/ 中需要将$userid、$id替换成对应的值
WB.client.parseCMD( "#{userid}/statuses/#{id}.json",//$userid $id会自动替换 function(sResult, bStatus) { if(bStatus == true){ //获取到id为107241523的用户的微博id为123的数据 } }, { userid : 107241523, id : 123 } );
或者
WB.client.parseCMD( "/107241523/statuses/123.json", function(sResult, bStatus) { if(bStatus == true){ //获取到id为107241523的用户的微博id为123的数据 } } );
sMeghod列表
获取下行数据集(timeline)接口
- sMeghod:/statuses/public_timeline.json 获取最新更新的公共微博消息
- sMeghod:/statuses/friends_timeline.json 获取当前用户所关注用户的最新微博信息
- sMeghod:/statuses/user_timeline.json 获取用户发布的微博信息列表
- sMeghod:/statuses/mentions.json 获取@当前用户的微博列表
- sMeghod:/statuses/comments_timeline.json 获取当前用户发送及收到的评论列表
- sMeghod:/statuses/comments_by_me.json 获取当前用户发出的评论
- sMeghod:/statuses/comments 获取指定微博的评论列表
- sMeghod:/statuses/counts.json 批量获取一组微博的评论数及转发数
- sMeghod:/statuses/unread.json 获取当前用户未读消息数
微博访问接口
- sMeghod:/statuses/show/{$id}.json 根据ID获取单条微博信息内容
- sMeghod:/{$userid}/statuses/{$id}.json 根据微博ID和用户ID跳转到单条微博页面(验证不成功)
- sMeghod:/statuses/update.json 发布一条微博信息
- sMeghod:/statuses/upload.json 上传图片并发布一条微博信息(验证不成功)
- sMeghod:/statuses/destroy/{$uid}.json 删除一条微博信息
- sMeghod:/statuses/repost.json 转发一条微博信息(可加评论)
- sMeghod:/statuses/comment.json 对一条微博信息进行评论
- sMeghod:/statuses/comment_destroy.json 删除当前用户的微博评论信息
- sMeghod:/statuses/reply.json 回复微博评论信息
用户接口
- sMeghod:/users/show.json 根据用户ID获取用户资料(授权用户)
- sMeghod:/statuses/friends.json 获取当前用户关注对象列表及最新一条微博信息
- sMeghod:/statuses/followers.json 获取当前用户粉丝列表及最新一条微博信息
私信接口
- sMeghod:/direct_messages.json 获取当前用户最新私信列表
- sMeghod:/direct_messages/sent.json 获取当前用户发送的最新私信列表
- sMeghod:/direct_messages/new.json 发送一条私信
- sMeghod:/direct_messages/destroy.json 删除一条私信
关注接口
- sMeghod:/friendships/create.json 关注某用户
- sMeghod:/friendships/destroy.json 取消关注
- sMeghod:/friendships/exists.json 是否关注某用户(推荐使用friendships/show)
- sMeghod:/friendships/show.json 获取两个用户关系的详细情况
Social Graph接口
- sMeghod:/friends/ids.json 获取用户关注对象uid列表
- sMeghod:/followers/ids.json 获取用户粉丝对象uid列表
账号接口
- sMeghod:/account/verify_credentials.json 验证当前用户身份是否合法
- sMeghod:/account/rate_limit_status.json 获取当前用户API访问频率限制
- sMeghod:/account/end_session.json 当前用户退出登录
- sMeghod:/account/update_profile_image.json 更改头像
- sMeghod:/account/update_profile.json 更改资料
- sMeghod:/account/register.json 注册新浪微博帐号
- sMeghod:/account/activate.json 二次注册微博的接口
收藏接口
- sMeghod:/favorites.json 获取当前用户的收藏列表
- sMeghod:/favorites/create.json 添加收藏
- sMeghod:/favorites/destroy.json 删除当前用户收藏的微博信息
登录/OAuth接口
- sMeghod:/oauth/request_token.json 获取未授权的Request Token
- sMeghod:/oauth/authorize.json 请求用户授权Token
- sMeghod:/oauth/access_token.json 获取授权过的Access Token