API接口文档

来自云登录
(版本间的差异)
跳转到: 导航, 搜索
第1行: 第1行:
 
__NOTOC__
 
__NOTOC__
 +
<div class="api_index">[[#用户类接口|用户类接口]]</div>
 +
<div class="api_index">[[#绑定类接口|绑定类接口]]</div>
 +
<div class="api_index">[[#同步类接口|同步类接口]]</div>
 +
<div class="api_index">[[#好友类接口|好友类接口]]</div>
 +
<div class="api_index">[[#其他类接口|其他类接口]]</div>
  
===接口描述===
 
网站删除用户时,把删除绑定关系同步到云登入,如果云登入没有同步,此媒体用户将不能再进行绑定操作。
 
  
===接口URL===
 
http://denglu.ex-sandbox.com/api
 
  
===支持格式===
 
'''JSON'''
 
  
===HTTP请求方式===
 
'''POST'''
 
  
===请求参数===
+
'''API通用说明'''
<div>
+
#'''云登入API'''
{|class="table" cellspacing="0" cellpadding="5" border="0"
+
|- style="background-color:#ffffcc;"
+
!参数
+
!是否必填
+
!描述
+
|-
+
|method
+
|是
+
|API接口名称
+
|-
+
|appid
+
|是
+
|你的云登入App ID
+
|-
+
|timestamp
+
|是
+
|时间戳,允许客户端请求时间误差为10分钟
+
|-
+
|sign_method
+
|是
+
|签名的加密方式,只支持MD5
+
|-
+
|v
+
|是
+
|API协议版本,可选值:1.0。
+
|-
+
|format
+
|否
+
|可选,指定响应格式。默认json,目前支持格式为xml,json
+
|-
+
|uid
+
|是
+
|访问平台的用户编号
+
|-
+
|sign
+
|是
+
|API输入参数签名结果
+
|}
+
</div>
+
  
===注意事项===
+
下面的几个部分详细描述了你需要向云登入的服务器发起的API调用接口。接下来的部分先讨论一般的请求(request)和回应(response)格式,以及针对每个API调用的报错情况。
+
  
===返回结果===
+
#'''请求(request)格式'''
<pre>
+
{
+
    "res": "succ"
+
}
+
</pre>
+
  
===字段说明===
+
每个从云登入API调用都以一个对应下表中的基础URL的HTTP POST开始。而且,每个调用方法都附了一个名称,以及一组必填或选填的参数。
<div>
+
{|class="table" cellspacing="0" cellpadding="5" border="0"
+
|- style="background-color:#ffffcc;"
+
!字段(键)
+
!描述
+
|-
+
|res
+
|解绑结果
+
|}
+
</div>
+
  
===示例代码===
+
<div>
 
<pre>
 
<pre>
$commit_url = "http://denglu.ex-sandbox.com/api/";
+
基础API的URL
$params['method'] = 'denglu.bind.all.delete';
+
 
$params['appid'] = '1438333333';
+
http://denglu.ex-sandbox.com/api/
$params['timestamp'] = time();
+
$params['sign_method'] = 'md5';
+
$params['v'] = '1.0';
+
$params['format'] = 'json';
+
$params['uid'] = '12';
+
$params['sign'] = _create_sign($params, '51c1af7c45a98d401beb7e024f0d412c');
+
$snoopy = new Snoopy();
+
$snoopy->submit($commit_url, $params);
+
 
</pre>
 
</pre>
具体见[[多语言SDK下载|云登入SDK]]
+
</div>
 +
 
 +
====用户类接口====
 +
[[获取用户信息|denglu.user.get]] 获取用户信息
 +
 
 +
可以通过denglu.user.get接口获取到平台供应商提供的用户信息,包括姓名、性别、爱好、好友、地址等等。
 +
 
 +
====绑定类接口====
 +
[[平台账号绑定|denglu.bind.add]] 平台账号绑定
 +
 
 +
可以通过denglu.bind.add接口使用户的平台账号和网站本身账号或者平台账号之间实现绑定。
 +
 
 +
 
 +
[[平台账号解除绑定|denglu.bind.delete]] 平台账号解除绑定
 +
 
 +
可以通过denglu.bind.delete接口使用户的平台账号和网站本身账号或者平台账号之间解除绑定。
 +
 
 +
 
 +
[[全部解除绑定|denglu.bind.all.delete]] 全部解除绑定
 +
 
 +
可以通过denglu.bind.all.delete接口使用户的所有账号绑定关系全部解除。
 +
 
 +
 
 +
[[获取绑定关系|denglu.bind.list]] 获取绑定关系
 +
 
 +
可以通过denglu.bind.list接口获取到用户的所有平台账号绑定关系,即使此用户并没有在你的网站上进行过绑定。
 +
 
 +
====同步类接口====
 +
[[发送登录新鲜事|denglu.send.login.feed]] 发送登录新鲜事
 +
 
 +
可以通过denglu.send.login.feed接口在用户使用平台账号登录网站时,向该平台发送一条登录信息。
 +
 
 +
[[同步信息|denglu.share.send]] 同步信息
 +
 
 +
用户可以通过denglu.share.send接口在用户发布帖子、日志、评论等信息时,把此信息同步到用户绑定的多个平台上。
 +
 
 +
====好友类接口====
 +
暂无
 +
 
 +
====其他类接口====
 +
[[获取已选择平台供应商|denglu.provider.get]] 获取已选择平台供应商
 +
 
 +
用户可以通过denglu.provider.get接口获取已经选择的所有平台供应商

2012年4月27日 (五) 11:54的版本



API通用说明

  1. 云登入API

下面的几个部分详细描述了你需要向云登入的服务器发起的API调用接口。接下来的部分先讨论一般的请求(request)和回应(response)格式,以及针对每个API调用的报错情况。

  1. 请求(request)格式

每个从云登入API调用都以一个对应下表中的基础URL的HTTP POST开始。而且,每个调用方法都附了一个名称,以及一组必填或选填的参数。

基础API的URL

http://denglu.ex-sandbox.com/api/

用户类接口

denglu.user.get 获取用户信息

可以通过denglu.user.get接口获取到平台供应商提供的用户信息,包括姓名、性别、爱好、好友、地址等等。

绑定类接口

denglu.bind.add 平台账号绑定

可以通过denglu.bind.add接口使用户的平台账号和网站本身账号或者平台账号之间实现绑定。


denglu.bind.delete 平台账号解除绑定

可以通过denglu.bind.delete接口使用户的平台账号和网站本身账号或者平台账号之间解除绑定。


denglu.bind.all.delete 全部解除绑定

可以通过denglu.bind.all.delete接口使用户的所有账号绑定关系全部解除。


denglu.bind.list 获取绑定关系

可以通过denglu.bind.list接口获取到用户的所有平台账号绑定关系,即使此用户并没有在你的网站上进行过绑定。

同步类接口

denglu.send.login.feed 发送登录新鲜事

可以通过denglu.send.login.feed接口在用户使用平台账号登录网站时,向该平台发送一条登录信息。

denglu.share.send 同步信息

用户可以通过denglu.share.send接口在用户发布帖子、日志、评论等信息时,把此信息同步到用户绑定的多个平台上。

好友类接口

暂无

其他类接口

denglu.provider.get 获取已选择平台供应商

用户可以通过denglu.provider.get接口获取已经选择的所有平台供应商

个人工具
社会化登录介绍