API文档

跳转到: 导航, 搜索
(用户接口)
 
(未显示9个用户的139个中间版本)
第1行: 第1行:
 +
<p class="tips_txt"><font style="color:red">重要:</font>新创建应用需要通过审核必须使用OAuth2.0和新版接口。 [[V1_To_V2|新版接口迁移指南]]
 +
[[API文档_V2|新版接口文档]] [[授权机制说明|OAuth2.0开发指南]]</p>
 +
 +
<div style="display:none;">
 +
 
== 微博基础数据接口 (Rest API) ==
 
== 微博基础数据接口 (Rest API) ==
 
=== 获取下行数据集(timeline)接口 ===
 
=== 获取下行数据集(timeline)接口 ===
*[[statuses/public_timeline]] 获取最新更新的公共微博消息
+
*[[statuses/public_timeline]] 获取最新的公共微博消息
*[[statuses/friends_timeline]]  获取当前用户所关注用户的最新微博信息 (别名: statuses/home_timeline)
+
*[[statuses/friends_timeline]]  获取当前登录用户及其所关注用户的最新微博消息 (别名: statuses/home_timeline)
*[[statuses/user_timeline]] 获取用户发布的微博信息列表
+
*[[statuses/user_timeline]] 获取用户发布的微博消息列表
 
*[[statuses/mentions]] 获取@当前用户的微博列表
 
*[[statuses/mentions]] 获取@当前用户的微博列表
 
*[[statuses/comments_timeline]] 获取当前用户发送及收到的评论列表
 
*[[statuses/comments_timeline]] 获取当前用户发送及收到的评论列表
 
*[[statuses/comments_by_me]] 获取当前用户发出的评论
 
*[[statuses/comments_by_me]] 获取当前用户发出的评论
 
*[[statuses/comments_to_me]] 获取当前用户收到的评论
 
*[[statuses/comments_to_me]] 获取当前用户收到的评论
*[[statuses/comments]] 获取指定微博的评论列表
+
*[[statuses/comments]] 根据微博消息ID返回某条微博消息的评论列表
 
*[[statuses/counts]] 批量获取一组微博的评论数及转发数
 
*[[statuses/counts]] 批量获取一组微博的评论数及转发数
 +
*[[statuses/repost_timeline]] 返回一条原创微博的最新n条转发微博信息 <span style="color:red;">New!</span>
 +
*[[statuses/repost_by_me]] 返回用户转发的最新n条微博信息 <span style="color:red;">New!</span>
 
*[[statuses/unread]] 获取当前用户未读消息数
 
*[[statuses/unread]] 获取当前用户未读消息数
 
*[[statuses/reset_count]] 未读消息数清零接口
 
*[[statuses/reset_count]] 未读消息数清零接口
 +
*[[emotions]]  表情接口,获取表情列表
  
 
=== 微博访问接口 ===
 
=== 微博访问接口 ===
 
*[[statuses/show]] 根据ID获取单条微博信息内容
 
*[[statuses/show]] 根据ID获取单条微博信息内容
 
*[[user/statuses/id]]  根据微博ID和用户ID跳转到单条微博页面
 
*[[user/statuses/id]]  根据微博ID和用户ID跳转到单条微博页面
*[[statuses/update]] 发布一条微博信息
+
*[[statuses/update]] 发布一条微博信息<span style="color:red">Updated!</span>
 
*[[statuses/upload]] 上传图片并发布一条微博信息
 
*[[statuses/upload]] 上传图片并发布一条微博信息
 
*[[statuses/destroy]] 删除一条微博信息
 
*[[statuses/destroy]] 删除一条微博信息
*[[statuses/repost]] 转发一条微博信息(可加评论)
+
*[[statuses/repost]] 转发一条微博信息<span style="color:red">Updated!</span>
*[[statuses/comment]] 对一条微博信息进行评论
+
*[[statuses/comment]] 对一条微博信息进行评论<span style="color:red">Updated!</span>
*[[statuses/comment_destroy]] 删除当前用户的微博评论信息
+
*[[statuses/comment_destroy|statuses/comment_destroy/:id]] 删除当前用户的微博评论信息
 
*[[statuses/comment/destroy_batch]] 批量删除当前用户的微博评论信息
 
*[[statuses/comment/destroy_batch]] 批量删除当前用户的微博评论信息
*[[statuses/reply]] 回复微博评论信息
+
*[[statuses/reply]] 回复微博评论信息<span style="color:red">Updated!</span>
  
 
=== 用户接口 ===
 
=== 用户接口 ===
*[[users/hot]] 获取系统推荐用户
 
 
*[[users/show]] 根据用户ID获取用户资料(授权用户)
 
*[[users/show]] 根据用户ID获取用户资料(授权用户)
 
<div style="display:none;">*[[user/friends/update_define]] 修改用户关注对象的备注信息</div>
 
<div style="display:none;">*[[user/friends/update_define]] 修改用户关注对象的备注信息</div>
*[[statuses/friends]] 获取当前用户关注对象列表及最新一条微博信息
+
*[[statuses/friends]] 获取用户关注列表及每个关注用户最新一条微博
*[[statuses/followers]] 获取当前用户粉丝列表及最新一条微博信息
+
*[[statuses/followers]] 获取用户粉丝列表及及每个粉丝用户最新一条微博
===黑名单接口 [NEW]===
+
*[[users/hot]] 获取系统推荐用户
*[[Blocks/create]] 将某用户加入黑名单
+
*[[user/friends/update_remark]]更新当前登录用户所关注的某个好友的备注信息<span style="color:red">New!</span>
 
+
*[[users/suggestions]] 返回当前用户可能感兴趣的用户 <span style="color:red">Beta!</span>
*[[Blocks/destroy]] 将某用户移出黑名单
+
  
*[[Blocks/exists]] 检测某用户是否是黑名单用户
+
<div style="display:none;">
  
*[[Blocks/blocking]] 列出黑名单用户(输出用户详细信息)
+
私信接口 <span style="color:red">高级</span>
 +
私信接口默认为限制接口
  
*[[Blocks/blocking/ids]] 列出分页黑名单用户(只输出id)
 
  
=== 私信接口 ===
 
 
*[[direct_messages]] 获取当前用户最新私信列表
 
*[[direct_messages]] 获取当前用户最新私信列表
 
*[[direct_messages/sent]] 获取当前用户发送的最新私信列表
 
*[[direct_messages/sent]] 获取当前用户发送的最新私信列表
 
*[[direct_messages/new]] 发送一条私信
 
*[[direct_messages/new]] 发送一条私信
*[[direct_messages/destroy]] 删除一条私信
+
*[[direct_messages/destroy|direct_messages/destroy/:id]] 删除一条私信
 
*[[direct_messages/destroy_batch]] 批量删除私信
 
*[[direct_messages/destroy_batch]] 批量删除私信
 +
</div>
  
 
=== 关注接口 ===
 
=== 关注接口 ===
第54行: 第60行:
 
*[[friendships/exists]] 是否关注某用户(推荐使用friendships/show)
 
*[[friendships/exists]] 是否关注某用户(推荐使用friendships/show)
 
*[[friendships/show]] 获取两个用户关系的详细情况
 
*[[friendships/show]] 获取两个用户关系的详细情况
 +
 +
===话题接口<span style="color:red">Beta!</span>===
 +
*[[trends]] 获取某人的话题
 +
*[[trends/statuses]] 获取某一话题下的微博
 +
*[[trends/follow]] 关注某一个话题
 +
*[[trends/destroy]] 取消关注的某一个话题
 +
*[[trends/hourly]] 按小时返回热门话题
 +
*[[trends/daily]] 返回当日热门话题。
 +
*[[trends/weekly]] 返回当周热门话题。
  
 
=== Social Graph接口===
 
=== Social Graph接口===
 
*[[friends/ids ]] 获取用户关注对象uid列表
 
*[[friends/ids ]] 获取用户关注对象uid列表
 
*[[followers/ids ]] 获取用户粉丝对象uid列表
 
*[[followers/ids ]] 获取用户粉丝对象uid列表
 +
===隐私设置接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[account/update_privacy]] 设置隐私信息
 +
*[[account/get_privacy]] 获取隐私信息
 +
 +
===黑名单接口 <span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[blocks/create]] 将某用户加入黑名单
 +
*[[blocks/destroy]] 将某用户移出黑名单
 +
*[[blocks/exists]] 检测某用户是否是黑名单用户
 +
*[[blocks/blocking]] 列出黑名单用户(输出用户详细信息)
 +
*[[blocks/blocking/ids]] 列出分页黑名单用户(只输出id)
 +
 +
===用户标签接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[tags]] 返回指定用户的标签列表
 +
*[[tags/create]] 添加用户标签
 +
*[[tags/suggestions]] 返回用户感兴趣的标签
 +
*[[tags/destroy]] 删除标签
 +
*[[tags/destroy_batch]] 批量删除标签
  
 
=== 账号接口 ===
 
=== 账号接口 ===
第65行: 第97行:
 
*[[account/update_profile_image]] 更改头像
 
*[[account/update_profile_image]] 更改头像
 
*[[account/update_profile]] 更改资料
 
*[[account/update_profile]] 更改资料
*[[account/register]] 注册新浪微博帐号
 
*[[Account/activate]] 二次注册微博的接口
 
  
 
=== 收藏接口 ===
 
=== 收藏接口 ===
第74行: 第104行:
 
*[[favorites/destroy_batch]] 批量删除收藏的微博信息
 
*[[favorites/destroy_batch]] 批量删除收藏的微博信息
  
===表情接口===
+
=== 短链接口 <span style="color:red; font-size:12px;">[NEW]</span>===
*[[emotions]] 表情接口,获取表情列表
+
*[[short_url/shorten ]] 将一个或多个长链接转换成短链接
 +
*[[short_url/expand]] 将一个或多个短链接还原成原始的长链接
 +
*[[short_url/share/counts]] 取得一个短链接在微博上的微博分享数(包含原创和转发的微博)
 +
*[[short_url/share/statuses]] 取得包含指定单个短链接的最新微博内容
 +
*[[short_url/comment/counts ]] 取得一个短链接在微博上的微博评论数
 +
*[[short_url/comment/comments]] 取得包含指定单个短链接的最新微博评论内容
  
 
=== 登录/OAuth接口 ===
 
=== 登录/OAuth接口 ===
第82行: 第117行:
 
*[[oauth/authorize]] 请求用户授权Token
 
*[[oauth/authorize]] 请求用户授权Token
 
*[[oauth/access_token]] 获取授权过的Access Token
 
*[[oauth/access_token]] 获取授权过的Access Token
 +
<span style="display:none"> *[[xAuth]] xAuth授权方式介绍 </span>
 +
=== 登录/OAuth 2.0接口===
 +
*[[OAuth2/access_token]] 获取授权过的Access Token
 +
*[[Oauth2/authorize]] 请求用户授权Token
  
== 微博搜索 API (Search API) ==
+
<div style="display:none;">
Search API仅对新浪合作开发者开放,申请请联系 @[http://t.sina.com.cn/openapi 微博开放平台]
+
微博搜索 API <span style="color:red">高级</span>
=== 用户搜索 ===
+
搜索接口默认为限制接口
*[[users/search]] 搜索微博用户  (仅对新浪合作开发者开放)
+
 
=== 微博搜索 ===
+
用户搜索
 +
*[[users/search]] 搜索微博用户  (仅对新浪合作开发者开放) <span style="color:red">  Updated!</span>
 +
*[[search/suggestions/at_users]] 在@某人时,实时获取用户名建议。亦可作关注人/粉丝搜索。(对所有开发者开放)<span style="color:red">New!</span>
 +
 
 +
微博搜索
 
*[[search]] 搜索微博文章 (仅对新浪合作开发者开放)
 
*[[search]] 搜索微博文章 (仅对新浪合作开发者开放)
 
*[[statuses/search]] 搜索微博(多条件组合) (仅对合作开发者开放)
 
*[[statuses/search]] 搜索微博(多条件组合) (仅对合作开发者开放)
 +
</div>
 +
 +
==微博地理位置信息接口==
 +
有任何问题,请联系 @[http://weibo.com/sinamap 新浪地图]
 +
 +
===地图引擎接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[Map-JS]] 是一套由JS语言编写的地图引擎,您可以用它在网站中构建功能丰富、交互性强的地图应用
 +
 +
===POI数据搜索接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[pois/keyword]] 根据关键字和(或)分类进行搜索,返回相关的poi点信息
 +
*[[pois/round]] 根据关键字和(或)分类,在中心点附近搜索,返回相关的poi点信息
 +
*[[pois/view]] 根据关键字和(或)分类,在一个矩形里进行搜索,返回相关的poi点信息
 +
 +
===POI数据处理接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[pois/add_poi]] 新增POI数据
 +
*[[pois/get_poi]] 获取新增POI数据
 +
 +
===移动定位接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[loc/get_location]] 根据基站、WIFI等其它数据,返回当前位置
 +
 +
===地址转换接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[geocode/ip_to_geo]] 根据ip返回地理信息
 +
*[[geocode/address_to_geo]] 根据地址返回坐标的接口
 +
*[[geocode/geo_to_address]] 根据坐标返回地址信息
 +
 +
===驾车路线搜索接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[navigation/route]] 驾车路线查询
 +
 +
===公交搜索接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[bus/transfer]] 根据起始id或坐标搜索公交换乘路线
 +
*[[bus/line]] 线路名称搜索
 +
*[[bus/station]] 公交站点名称搜索
 +
 +
===空间计算接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[distance/distance_point]] 计算地图上两点之间的距离
 +
*[[distance/distance_po_li]] 计算地图上(x,y)到线的最近距离
 +
*[[distance/distance_line]] 计算地图上线的长度
 +
 +
===静态地图接口<span style="color:red; font-size:12px;">[NEW]</span>===
 +
*[[base/get_map_image]]生成一个静态地图的图片
  
== 微博地理位置信息API (Location API) ==
+
===地理位置信息接口错误代码及解释===
Map API仅对新浪合作开发者开放,有任何问题,请联系 @[http://t.sina.com.cn/mapapi 地理信息开放平台]
+
*[[location/error]] 地理位置信息接口错误代码及解释
=== 地理信息搜索接口 ===
+
*[[Location/route]] 驾车路线搜索接口
+
*[[Location/bus]] 公交换乘路线搜索接口
+
=== 坐标获取接口 ===
+
*[[Location/ip2xy]] 获取ip对应坐标的接口
+
*[[Location/addr2xy]] 获取地址对应坐标的接口
+
*[[Location/get_addr]] 获取坐标的地址信息的接口
+
  
 
== 测试接口 ==
 
== 测试接口 ==
*[[Help/test]] 测试接口
+
*[[help/test]] 测试接口
  
 
== 附录 ==
 
== 附录 ==
第111行: 第187行:
 
*[[direct_message]] 私信信息
 
*[[direct_message]] 私信信息
 
*[[省份城市编码表]]
 
*[[省份城市编码表]]
 +
*[[Metadata]] 元数据<span style="color:red;">  New!</span>
 +
 
=== 地理信息字段说明 ===
 
=== 地理信息字段说明 ===
*[[Location/citycode]] 城市代码对应表
+
*[[location/citycode]] 城市代码对应表
*[[Location/citycode_bus]] 公交城市代码表
+
*[[location/citycode_bus]] 公交城市代码表
*[[Location/category]] 分类代码对应表
+
*[[location/category]] 分类代码对应表
 +
 
 +
</div>
 +
 
 +
__NOTOC__

2017年2月21日 (二) 12:16的最后版本

重要:新创建应用需要通过审核必须使用OAuth2.0和新版接口。 新版接口迁移指南 新版接口文档 OAuth2.0开发指南

微博基础数据接口 (Rest API)

获取下行数据集(timeline)接口

微博访问接口

用户接口

  • users/show 根据用户ID获取用户资料(授权用户)
*user/friends/update_define 修改用户关注对象的备注信息

私信接口 高级 私信接口默认为限制接口


关注接口

话题接口Beta!

Social Graph接口

隐私设置接口[NEW]

黑名单接口 [NEW]

用户标签接口[NEW]

账号接口

收藏接口

短链接口 [NEW]

登录/OAuth接口

*xAuth xAuth授权方式介绍

登录/OAuth 2.0接口

微博搜索 API 高级 搜索接口默认为限制接口

用户搜索

  • users/search 搜索微博用户 (仅对新浪合作开发者开放) Updated!
  • search/suggestions/at_users 在@某人时,实时获取用户名建议。亦可作关注人/粉丝搜索。(对所有开发者开放)New!

微博搜索

  • search 搜索微博文章 (仅对新浪合作开发者开放)
  • statuses/search 搜索微博(多条件组合) (仅对合作开发者开放)

微博地理位置信息接口

有任何问题,请联系 @新浪地图

地图引擎接口[NEW]

  • Map-JS 是一套由JS语言编写的地图引擎,您可以用它在网站中构建功能丰富、交互性强的地图应用

POI数据搜索接口[NEW]

  • pois/keyword 根据关键字和(或)分类进行搜索,返回相关的poi点信息
  • pois/round 根据关键字和(或)分类,在中心点附近搜索,返回相关的poi点信息
  • pois/view 根据关键字和(或)分类,在一个矩形里进行搜索,返回相关的poi点信息

POI数据处理接口[NEW]

移动定位接口[NEW]

地址转换接口[NEW]

驾车路线搜索接口[NEW]

公交搜索接口[NEW]

空间计算接口[NEW]

静态地图接口[NEW]

地理位置信息接口错误代码及解释

测试接口

附录

Rest API字段说明

地理信息字段说明


文档更新时间: 2017-02-21