开心连接

开心连接简介

开心连接(Connect)是为第三方网站或客户端提供的接入服务,它能够让用户直接用开心网账号登录你的网站或客户端,降低使用门槛;同时,用户可以将精彩内容分享到开心网,通过好友关系进行广泛传播,从而提高网站/客户端的曝光率、社交性和用户活跃度。

开心连接与OpenID

开心网开放平台原来的OpenID实现过程,主要采用跨域种Cookie的方式验证用户身份,获取调用开放API的权限。

目前开心网开放平台已启用OAuth协议,完善了用户身份认证和权限管理方式,减少了第三方在实现连接开心网过程中的开发成本。

开心网开放平台保留对原有验证与授权方式的支持,但已关闭OpenID的申请,请使用OAuth协议进行连接开心网的开发。如果你之前申请过OpenID,请点击这里查看详情。

开心网同时支持OAuth1.0aOAuth2.0以及xAuth,与OAuth1.0a相比,OAuth2.0获取Access Token的方式更加丰富,xAuth则是针对OAuth1.0a在桌面/移动客户端的完善。开发者可以根据情况,自行选择进行开发。

开发流程

下面是开心连接开发的基本流程:

1. 创建应用

如果您是第一次创建应用,需要首先注册为开发者;填写开发者信息,并成功验证邮箱后即注册为开心网开放平台的开发者。开心网通过您留下的手机号码、邮箱等与您联系,请务必如实填写。如信息填写有误,可能造成应用审核延迟或无法通过。如果在注册开发者过程中有问题,请参考注册开发者详细说明或咨询在线产品支持

注册为开发者后,您就可以创建应用了。请进入开放平台我的应用页面,点击右上方的“创建新应用”按钮,选择“连接网站”类型,填写应用名称并同意开发者协议即完成应用创建。

1) 点击“创建新应用”按钮

2) 选择“连接网站”类型

3)填写应用名称完成创建

2. 编辑应用信息

2.1 应用基本信息

基本信息每项均为必填,填写完毕务必点击“保存”按钮。

2.2 应用地址

1) 网站地址:网站首页地址
2) 登录页地址:网站登录页面地址,让开心网用户从开心网直接跳转到您的网站登录页面

2.3 应用图标

应用图标用于应用中心列表页、个人页面应用菜单、动态流等处,务必按照要求上传相应格式、大小的图片资源。

注意:由于图标多放在有背景色的页面中,因此图标底色需设置为透明或非白色的其他颜色,这样才能与开心网的整体页面风格协调起来;
请开发者务必按照要求的格式、大小提供相应的图标和截图;图标不合格会影响应用的审核、上线。

3. 功能开发

应用创建完毕后即可获取APP ID/API Key/Secret Key,同时您就获得了OAuth等开放API的调用权限。

3.1 应用授权

开心连接目前采用OAuth协议,开发时请参考:OAuth1.0a文档OAuth2.0文档xAuthAPI2.0文档API2.0调用示例接口访问权限说明

另外,开心网还提供了各种语言版本的SDK供你下载参考,立即下载SDK

3.2 登录流程

以下是简单的“开心连接”登录流程。详细的开发文档请参考OAuth1.0aOAuth2.0xAuth

1. 在网站设置“用开心网账号登录”按钮入口

图标: 更多图标请参考标识素材

登录地址就是OAuth授权地址

可以将此按钮放置在网站首页、登录页、注册页等与用户登录相关的重要页面。下面是美团网的例子:

2. 输入开心网账号、密码登录
用户点击“用开心网账号登录”按钮,弹出登录页面,在此页面显示要连接网站的名称

3. 用户授权开心网与第三方网站连接
用户第一次“用开心网账号登录”连接网站时,弹出授权页面。用户选择允许第三方网站进行的操作

4. 第三方网站引导用户进行账号绑定
用户第一次用开心网账号登录你的网站,第三方网站可以自动为此用户创建一个普通账号,此用户就能正常登录了。同时,你可以将新创建的账号与开心网账号绑定,此种方式对用户来说是最佳的使用体验。

当然,你也可以让用户在登录后重新设定要绑定的普通账号。用户绑定新账号后,原本自动创建的普通账号可以作废。

*开心网推荐第三方网站使用此方式进行账号绑定。此方式对用户来说,操作最方便、快捷;对第三方网站来说,开心网用户也可以很容易地转化为合作网站的自有用户。

3.3 常用API

目前,开心网开放平台已经正式发布了100多个API,包括发布记录(可带图)、发送动态、系统消息和邀请等大量功能接口。您可以尽量利用这些API,将社交功能融入到您的网站/客户端中,将精彩内容分享到开心网,强化社交性。

第三方经常用到的接口有:

功能分类接口名称接口说明
授权认证OAuth2.0授权流程
用户信息/users/me获取当前登录用户的资料
/users/show根据UID获取多个用户的资料
好友关系/friends/me获取当前登录用户的好友资料
应用信息/app/status获取用户安装应用的状态
/app/rate_limit_status查询当前APP剩余请求次数
平台基础功能/records/add发表一条记录(可带图)
/album/create创建一个照片专辑
/photo/upload上传一张照片到指定照片专辑
/gift/send在某个位置签到,并发出一条动态,与好友分享
社交部件分享部件将网页内容方便地分享到开心记录中
粉丝部件让用户方便地加为你公共主页的粉丝
评论部件让用户方便地对你的应用发表评论内容

3.4 功能测试

为防止不完整的功能外泄,影响用户体验,“连接网站”类应用在审核通过前,只有测试用户才能使用您网站的“开心连接”功能;审核通过后,才能为一般用户所使用。因此,您的网站正式发布“开心连接”功能前,请务必确认应用已经审核通过,否则一般用户将无法使用该功能。

请到应用的“开发人员管理”页面,添加开发人员;开发人员分为四类,每类对应不同的权限,请根据情况添加,详细如下表所示:

角色重置Secret Key删除应用添加开发人员编辑应用信息测试未上线的应用查看统计数据测试开心币人数上限
管理员2
开发者×××2
测试用户×××××10
数据用户××××××2

关于添加开发人员的方法,请参考添加开发人员说明

3.5 移动应用接入

开心连接也支持移动终端上的APP或网站接入,详情请看移动应用接入流程

4. 提交审核

请务必完善应用信息后提交审核,开放平台工作人员会在1-2个工作日内,通过邮件或电话将审核结果告诉您。

5. 正式发布

应用审核通过后,您才能将网站/客户端的“开心连接”功能正式发布;如果您申请的应用未提交审核或审核未通过,您发布后,只能测试账号才能使用,一般用户无法使用该功能。