畅言社会化评论系统社交评论插件开发

1、畅言 社会化评论系统 技术文档Web网站接入指南概述畅言提供了多种接入方式，开发者可以按需选择：使用JS嵌入的方式；直接调用畅言开放API接口的方式多种接入方式1、JS嵌入流程注册完成后出现如下图界面JS代码嵌入JS代码嵌入是最简易的网站接入方式。将生成的JS代码复制并粘贴到您网页需要的地方；如果您的网站使用的模板，您也可以复制代码到您的模板中，社会化评论框将在所有网页自动出现，此时您就可以轻松获取畅言服务！2、API接口调用除了使用JS代码嵌入方式外，您还可以通过调用畅言平台的API接口，获得更深度的定制。具体的API调用方式及接口说明文档，请参考 开放平台-API开放接口。注意：

2、当您使用JS嵌入的方式来生成评论框，但是文章没有唯一URL地址时，或者对于同一篇文章有多页展示，但是需要显示的是相同的评论内容时，可以配置source id来区分文章（即文章的id）。具体如何配置，请参考 高级开发-自定义配置自定义配置概述在插入通用代码时，可以增加一些参数，来实现自定义的功能配置source id当您使用JS嵌入的方式来生成评论框，但是文章没有唯一URL地址时，或者对于同一篇文章有多页展示，但是需要显示的是相同的评论内容时，可以配置source id来区分文章（即文章的id）。“#source id#"是您需要配置的部分，如下图配置owner id当您需要

3、使用删除通知接口时，需要先配置owner id（即文章所有者的id）。“#owner id#"是您需要配置的部分，如下图发布者删除评论概述对于UGC（如博客等）类网站，当内容发布者发布的内容被评论，但是却想要删除此评论时，畅言提供了以下解决方案。在使用前请先配置owner id。具体如何配置，请参考 高级开发-自定义配置发布者删除评论1、删除评论流程图如下2、验证接口（需要您提供）描述：用于验证当前登录用户是否为内容发布者URL： 点击到后台设置中填写请求方式：GET请求参数：参数名类型是否必须说明owner_idStringY内容所有者ID-由您提供topic_

4、urlStringN当前页面的URL，和topic_source_id二选其一topic_source_idStringN内容ID，和topic_url二选其一-由您提供返回：JSON格式字段名类型说明ownerint有无删除评论的权限（1：有权限，0：无权限）代码样式 "owner": 13、验证删除信息接口（需要您提供）描述：验证前端发起的删除请求是否内容所有者发起URL： 点击到后台设置中填写请求方式：POST请求参数：参数名类型是否必须说明client_idStringYAPP ID-由畅言供owner_idStringY内容所有者ID-由您提供topic

5、_idStringY新闻ID畅言IDcomment_idStringY评论ID畅言IDtopic_urlStringN当前页面的URL，和topic_source_id二选其一topic_source_idStringN文章ID，和topic_url二选其一-由您提供返回：JSON格式字段名类型说明successint是否删除成功（1：删除成功，0：删除失败）代码样式 "success": 14、删除评论接口（畅言提供）描述：验证通过后，调用畅言删除接口URL：请求方式：POST请求参数：参数名类型是否必须说明client_idStringYAPP ID-由畅言供owner

6、_idStringY内容所有者ID-由您提供topic_idStringY新闻ID畅言IDcomment_idStringY评论ID畅言IDsignStringY签名方式为按照所有参数（除sign参数外）的字典顺序即name=value的形式以&符号链接起来，然后使用HmacSha1方式以client_secret作为密钥进行签名返回。返回：如果成功返回空，失败返回错误信息。（JSON格式）字段名类型说明error_codeString错误码error_msgString错误信息发布者获取新评论概述对于UGC（如博客等）类网站，当内容发布者想获得发布的内容的新评论列表时，畅言提供了以下

7、解决方案。在使用前请先配置owner id。具体如何配置，请参考 高级开发-自定义配置发布者获取新评论1、获得新评论接口描述：获取内容所有者的最新评论列表URL：请求方式：GET请求参数：参数名类型是否必须说明client_idStringYAPP ID-由畅言供owner_idStringY内容所有者ID-由您提供page_nointN页数page_sizeintN每页条数callbackStringN回调接口返回：JSON格式字段名类型说明passportJson对象评论作者commentsJson评论数组评论列表comment_request_keyString保存评论顶/踩数

8、key，当调用接口api/open/topic/action时，传入此参数刷新页面会立即更新分享数和喜欢数topic_request_keyString保存新闻喜欢数和分享数的key，当调用接口api/open/comment/action时，传入此参数刷新页面会立即更新分享数和喜欢数cmt_sumint新闻的评论总数（包括对评论的回复）outer_cmt_sumint新闻的直接评论数（评论翻页时使用）代码样式 "comments": "content": "fasd", "comment_id": 18627,

9、"support_count": 0, "oppose_count": 0, "reply_count": 8, "comment_request_key": "loadTopicComments?d77d221a5a83b78b3be3447c720821a8", "from": "", "status": 0, "passport": "passport_id": 585, "use

10、r_id": 5105, "platform_id": 11, "nickname": "xuluxi_111", "img_url": "", "profile_url": "", "is_shared": false, "expired": false , "comments": "content": "回复 xuluxi_111：fds",

11、"comment_id": 18635, "support_count": 1, "oppose_count": 0, "reply_count": 0, "cache_key": "loadTopicComments?d77d221a5a83b78b3be3447c720821a8", / "from": "", "status": 0, "passport": "passport_i

12、d": 585, "user_id": 5105, "platform_id": 11, "nickname": "xuluxi_111", "img_url": "", "profile_url": "", "is_shared": false, "expired": false , "content": "回复 xuluxi_111：gsd",

13、 "comment_id": 18634, "support_count": 0, "oppose_count": 1, "reply_count": 0, "cache_key": "loadTopicComments?d77d221a5a83b78b3be3447c720821a8", "from": "", "status": 0, "passport": "passport_id

14、": 585, "user_id": 5105, "platform_id": 11, "nickname": "xuluxi_111", "img_url": "", "profile_url": "", "is_shared": false, "expired": false , . , "content": "测试", "comme

15、nt_id": 18604, "support_count": 0, "oppose_count": 0, "reply_count": 0, "comment_request_key": "loadTopicComments?d77d221a5a83b78b3be3447c720821a8", "from": "", "status": 0, "passport": "passport_id&q

16、uot;: 531, "user_id": 4881, "platform_id": 2, "nickname": "_pyx", "img_url": " "profile_url": " "is_shared": false, "expired": false , "comments": , , "topic_id": 5018, "cmt_sum":

17、396, /评论总数 "outer_cmt_sum": 150, "participation_sum": 571, /分享数 "like_sum": 35, /喜欢数 "topic_request_key": "loadTopicComments?d77d221a5a83b78b3be3447c720821a8" 单点登录开发概述当接入畅言的网站有自己的账号系统时，想实现和畅言目前的账号体系兼容时，畅言提供以下单点登录解决方案，达到的效果为：您的网站和畅言评论框任一方登录了，另一方自动登录；任

18、一方退出，另一方自动退出单点登录方案1、登录流程2、退出流程3、登录接口（需要您提供）描述：用户在畅言登录后，畅言调用此接口，使您的网站同步登录URL： 点击到后台设置中填写请求方式：GET请求参数：参数如下参数名类型是否必须说明cy_user_idintY畅言uidnicknameStringY畅言用户的昵称，长度小于1023个字节（如果为空则传空字符串）。img_urlStringY畅言用户的头像，长度小于1023个字节（如果为空则传空字符串）。profile_urlStringY畅言用户的个人中心地址，长度小于1023个字节（如果为空则传空字符串）。user_idStringY

19、第三方接入网站的用户idsignStringY参数签名信息。签名方式为按照所有参数(除sign参数外)的字典顺序即name=value的形式以&符号链接起来，然后以client_secret作为密钥进行用HMACSHA1算法进行签名）isv应该对所有入参（除sign外）计算签名，然后与此参数进行比较，以防止参数被篡改。callbackStringY回调函数返回：Jsonp格式，返回参数如下参数名类型说明user_idString长度小于100个字节，登录失败返回空字符串返回代码示例：假设参数callback的值为"aaa"aaa(user_id : "21

20、315")4、获取用户信息接口（需要您提供）描述：畅言调用此接口，查询是否有用户登录（若有则畅言实现同步登录）URL： 点击到后台设置中填写请求方式：GET请求参数：参数如下参数名类型是否必须说明callbackStringY回调函数返回：Jsonp格式，返回参数如下参数名类型说明cy_user_idint畅言uidnicknameString第三方接入网站用户的昵称，长度小于63个字节（如果为空则传空字符串）。img_urlString第三方接入网站用户的头像，长度小于1023个字节（如果为空则传空字符串）。profile_urlString第三方接入网站用户的个人中心地

21、址，长度小于1023个字节（如果为空则传空字符串）。user_idString第三方接入网站的用户id，长度小于100个字节（如果为空则传空字符串）is_loginint用户是否登录标志 0表示未登录，1表示已登录（登录需要返回user对象）signString参数签名信息。签名方式为按照所有参数(除sign参数外)的字典顺序即name=value的形式以&符号链接起来，然后以client_secret作为密钥进行用HMACSHA1算法进行签名）isv应该对所有入参（除sign外）计算签名，然后与此参数进行比较，以防止参数被篡改。callbackString回调函数返回代码示例：已登录

22、用户，假设参数callback的值为"aaa" aaa( "is_login ": 1,"user": "img_url": ""nickname": "aaas","profile_url": "","user_id": 42417,"cy_user_id":"23243","sign":"werdfasdfasdf")返回代

23、码示例：未登录用户,假设参数callback的值为"aaa"aaa("is_login ": 0)5、用户退出接口（由您提供）描述：当畅言退出时，调用此接口，实现用户在您的网站退出URL： 点击到后台设置中填写请求方式：GET请求参数：参数如下参数名类型是否必须说明codeintY0退出失败，1退出成功callbackStringY回调函数返回：Jsonp格式，返回参数如下参数名类型说明codeint0退出失败，1退出成功返回代码示例：假设参数callback的值为"aaa"aaa("code"：1)6、

24、畅言退出接口（由畅言提供）描述：当用户单点登录成功后，用户在第三方退出时，第三方需要调用畅言的退出接口，以通知畅言也让此用户在畅言退出。URL：请求方式：GET请求参数：参数如下参数名类型是否必须说明callbackStringY回调函数返回格式：Jsonp格式参数名类型说明codeint0退出失败，1退出成功返回代码示例：假设参数callback的值为"aaa"aaa("code"：1)Oauth认证Oauth2.01、Oauth2.0概述Oauth2.0认证框架提供了第三方应用的认证流程，第三方应用可以通过HTTP服务获得有限的资源访问权限，即第三方

25、应用可以通过该协议获取访问畅言系统部分资源的权限。通过该认证方式保证用户的密码不会泄露给第三方应用，同时用户还可以选择性地授权第三方应用访问用户自己有限的信息。2、Oauth2.0流程畅言Oauth2.01、畅言Oauth2.0概述由于畅言支持社会化登录，所以授权相对复杂些。在使用前请先申请client_id与client_secre。畅言开放平台的Oauth2.0认证框架支持的认证方式为：授权码(Authorization Code)认证。第三方应用首先通过client_id和RedirectUri引导用户进入畅言平台的认证接口，当用户认证成功后会通过HTTP Redirect的方式将该Co

26、de传递给第三方提供的Redirect Uri。然后第三方通过该Authorization Code和自己申请到的client_secret向畅言服务器请求获取AccessToken，如果全部成功则畅言服务器返回一个AccessToken给第三方。之后第三方就可以通过该AccessToken访问畅言系统的OAuth API。畅言平台的Oauth2.0暂不支持RefreshToken的策略。2、畅言Oauth2.0流程3、获取AuthorizationCode接口名：/api/oauth2/authorizeURL：请求方式：GET请求参数：参数名类型是否必须说明client_idStringY

27、畅言appIdredirect_uriStringY授权回调地址，必须和用户注册时填的一致response_typeStringY响应类型,必须为codescopeStringN用户授权时向用户显示的可进行授权的列表platform_idlongNplatform_id可取>0(具体的第三方登录页 2为新浪、3为qq、4为腾讯微博、5为网易微博、6为人人、7为百度、8为豆瓣、11为搜狐Passport)、默认（游客和第三方）stateStringNclient端的状态值,用于第三方应用防止CSRF攻击，成功授权后回调时会原样带回。displayStringN授权页面的终端类型，取值见下面

28、的说明。（default默认的授权页面，适用于web浏览器；mobile指移动设备）。scopeStringN用户授权时向用户显示的可进行授权的列表返回：字段名类型说明CodeString用户授权的codeStateString如果请求时传递了state参数，会回传该参数代码样式请求授权code& response_type=code&platform_id=-1如果授权成功，畅言授权服务器会将用户浏览器重定向到redirect_uri第三方应用（ISV）获取到畅言授权的code（code有效期为10分钟，且只能使用一次）之后，就可以使用此code调用/api/oauth2/t

29、oken接口，换取用户授权的access_token。4、获取AccessToken接口名：/api/oauth2/tokenURL：请求方式：POST请求参数：参数名类型是否必须说明client_idStringY畅言appIdclient_secretStringYappKeygrant_typeStringY响应类型（可以为authorization_code、password、refresh_token），当前只支持authorization_codecodeStringN授权接口返回的授权码（当参数grant_type值为authorization_code必填)redirect_u

30、riStringN回调地址（当参数grant_type值为authorization_code必填）refresh_tokenStringN用于刷新的refresh_token（当参数grant_type值为refresh_token必填）返回：字段名类型说明access_tokenString访问畅言用户资源的凭证，调用开放接口时需要expires_inlongaccess_token的失效时间，单位为秒代码样式"access_token": "10000|5.a6b7dbd428f731035f771b8d15063f61.86400.1292922000-2

31、22209506","expires_in": 87063分类接口接口说明基本接口api/open/topic/load加载文章的评论列表。根据文章topic_source_id或者URL获取文章id(topic_id)，并返回第一页评论信息api/open/comment/list通过分页方式获得评论数据api/open/user/info获取登录用户的信息(包括绑定的账号）api/open/user/comment/submit发表评论并分享到第三方分类接口接口说明用户接口api/open/user/passport/unbinding解除用户（某个账号）的绑

32、定api/oauth2/binding绑定（第三方开放平台账号到当前登录）用户评论接口api/open/user/comment/share只分享评论（到第三方开放平台）api/open/user/comment/reply获取用户收到的最新回复列表api/open/comment/reply获取某个评论的回复列表api/opentopic/comment/sum获取文章评论总数api/open/topic/info获取文章的新闻评论数、参与数、喜欢数api/open/user/attachment/add上传图片喜欢接口api/open/topic/action喜欢（文章）顶踩接口api/o

33、pen/comment/action顶/踩（回复）错误代码概述当接入方调用开放API出现错误时，返回相应的错误代码。错误代码由五位数字组成，从左到右，第一数字表示服务级错误，第二位和第三位表示服务模块代码，第四位和第五位表示具体错误代码第一数字第二、三个数字第四、五个数字服务级错误（1为业务错误，2为权限错误）服务模块代码具体错误代码业务错误1、服务模块错误代码错误代码错误类型00通用错误01主体02用户2、具体业务错误代码错误代码错误类型10000系统内部错误10001非法的请求参数10002验证码错误10100文章url或者文章id为空10200不能解绑当前登录用户10201不能主动绑定来

34、自同一平台的2个用户10202同一平台用户绑定数不能超过5个10203游客昵称包含非法词10204游客昵称或邮箱长度过长10205解绑的账号不属于没有与登录用户过权限错误1、服务模块错误代码错误代码错误类型00通用错误01Oauth授权验证02频率控制2、具体业务错误代码错误代码错误类型20000Oauth授权验证异常20101code过期20102code非法20103code重复使用20104token过期20105token非法20106签名错误20107非法的client_id20108redirect_uri非法20109参数response_type必须为code20110参数gr

35、ant_type必须为authorization_code20111缺少Oauth授权参数20112参数nonce的值重复使用数据导出概述畅言提供了数据导出功能，用户可以根据自己的需要导出特定时间段的数据,不包括删除的评论,不包括删除的评论导出数据的格式说明参数名类型说明successboolean数据是否导出成功messageString错误信息，导出失败时提示commentsJSON评论数组评论列表topicUrlString文章URLtopicTitleString文章标题topicIdlong文章IDsourceTopicIdString文章的原始IDtopicLikeSumlong文

36、章的被喜欢数topickShareSumlong文章被分享数cmtIdlong评论IDcontentString评论内容attachsJson数组图片评论ctimeDate评论发表时间splong评论被顶次数oplong评论被踩次数replyIdlong所回复的评论的ID，为0表示没有回复其他评论nicknameString用户昵称fromString用户账号来源iconUrlString用户头像(如果为空，表示使用默认头像）userProfileUrlString用户个人主页代码样式 "success": true, "comments": "

37、;attachs": "url": " , "cmtId": 36475, "content": "分享图片5555", "ctime": "2013-05-14 16:13:25", "from": "游客", "iconUrl": "", "nickname": "赢者无敌1914", "op": 0, "replyId": 0, "sourceTopicId": "", "sp": 0, "topicId": 897, "topicLikeSum": 0, "topicTitle": "Insert title here+finalJs-用户信息完毕", "topicUrl": "http:/