API接口文档
(未显示1个用户的39个中间版本) | |||
第1行: | 第1行: | ||
__NOTOC__ | __NOTOC__ | ||
− | + | <div class="api_index">[[#用户类接口|用户类接口]]</div> | |
− | <div class="api_index">[[用户类接口|用户类接口]]</div> | + | <div class="api_index">[[#绑定类接口|绑定类接口]]</div> |
− | <div class="api_index">[[ | + | <div class="api_index">[[#同步类接口|同步类接口]]</div> |
− | <div class="api_index">[[ | + | <div class="api_index">[[#其他类接口|其他类接口]]</div> |
− | <div class="api_index">[[ | + | |
第11行: | 第10行: | ||
'''API通用说明''' | '''API通用说明''' | ||
− | # | + | #'''云登录API''' |
+ | |||
+ | 下面的几个部分详细描述了你需要向云登录的服务器发起的API调用接口。接下来的部分先讨论一般的请求(request)和回应(response)格式,以及针对每个API调用的报错情况。 | ||
+ | |||
#'''请求(request)格式''' | #'''请求(request)格式''' | ||
+ | |||
+ | 每个从云登录API调用都以一个对应下表中的基础URL的HTTP POST开始。而且,每个调用方法都附了一个名称,以及一组必填或选填的参数。 | ||
+ | |||
+ | <div> | ||
+ | <pre> | ||
+ | 基础API的URL | ||
+ | |||
+ | http://www.ecopen.cn/api/ | ||
+ | </pre> | ||
+ | </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.list]] 获取云登录平台支持的所有平台供应商,及用户平台选择情况 | ||
+ | |||
+ | 用户可以通过denglu.provider.list接口获取云登录平台支持的平台供应商,及用户平台选择情况 | ||
+ | |||
+ | [[修改平台供应商|denglu.provider.edit]] 修改平台供应商 | ||
+ | |||
+ | 用户可以通过denglu.provider.edit接口修改平台供应商及排序等 | ||
+ | |||
+ | [[站点创建|denglu.site.add]] 站点创建 | ||
+ | |||
+ | 用户可以通过denglu.site.add接口给指定会员(登录帐号)创建站点 | ||
+ | |||
+ | [[站点信息的修改|denglu.site.edit]] 用户站点信息的修改 | ||
+ | |||
+ | 用户可以通过denglu.site.edit接口来修改应用站点 | ||
+ | |||
+ | [[云登录样式按钮列表|denglu.style.list]] 云登录支持的样式按钮列表 | ||
+ | |||
+ | 可以通过denglu.style.list接口来获取云登录平台支持的样式按钮列表 | ||
+ | |||
+ | [[站点样式修改|denglu.style.edit]] 站点样式修改 | ||
+ | |||
+ | 可以通过denglu.style.edit接口来修改站点的按钮样式显示方式 |
2012年6月11日 (一) 10:28的最后版本
API通用说明
- 云登录API
下面的几个部分详细描述了你需要向云登录的服务器发起的API调用接口。接下来的部分先讨论一般的请求(request)和回应(response)格式,以及针对每个API调用的报错情况。
- 请求(request)格式
每个从云登录API调用都以一个对应下表中的基础URL的HTTP POST开始。而且,每个调用方法都附了一个名称,以及一组必填或选填的参数。
基础API的URL http://www.ecopen.cn/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.list 获取云登录平台支持的所有平台供应商,及用户平台选择情况
用户可以通过denglu.provider.list接口获取云登录平台支持的平台供应商,及用户平台选择情况
denglu.provider.edit 修改平台供应商
用户可以通过denglu.provider.edit接口修改平台供应商及排序等
denglu.site.add 站点创建
用户可以通过denglu.site.add接口给指定会员(登录帐号)创建站点
denglu.site.edit 用户站点信息的修改
用户可以通过denglu.site.edit接口来修改应用站点
denglu.style.list 云登录支持的样式按钮列表
可以通过denglu.style.list接口来获取云登录平台支持的样式按钮列表
denglu.style.edit 站点样式修改
可以通过denglu.style.edit接口来修改站点的按钮样式显示方式