暢言社會(huì)化評論系統(tǒng)社交評論插件開發(fā)

1、暢言 社會(huì)化評論系統(tǒng) 技術(shù)文檔Web網(wǎng)站接入指南概述暢言提供了多種接入方式，開發(fā)者可以按需選擇：使用JS嵌入的方式；直接調(diào)用暢言開放API接口的方式多種接入方式1、JS嵌入流程注冊完成后出現(xiàn)如下圖界面JS代碼嵌入JS代碼嵌入是最簡易的網(wǎng)站接入方式。將生成的JS代碼復(fù)制并粘貼到您網(wǎng)頁需要的地方；如果您的網(wǎng)站使用的模板，您也可以復(fù)制代碼到您的模板中，社會(huì)化評論框?qū)⒃谒芯W(wǎng)頁自動(dòng)出現(xiàn)，此時(shí)您就可以輕松獲取暢言服務(wù)！2、API接口調(diào)用除了使用JS代碼嵌入方式外，您還可以通過調(diào)用暢言平臺的API接口，獲得更深度的定制。具體的API調(diào)用方式及接口說明文檔，請參考 開放平臺-API開放接口。注意：

2、當(dāng)您使用JS嵌入的方式來生成評論框，但是文章沒有唯一URL地址時(shí)，或者對于同一篇文章有多頁展示，但是需要顯示的是相同的評論內(nèi)容時(shí)，可以配置source id來區(qū)分文章（即文章的id）。具體如何配置，請參考 高級開發(fā)-自定義配置自定義配置概述在插入通用代碼時(shí)，可以增加一些參數(shù)，來實(shí)現(xiàn)自定義的功能配置source id當(dāng)您使用JS嵌入的方式來生成評論框，但是文章沒有唯一URL地址時(shí)，或者對于同一篇文章有多頁展示，但是需要顯示的是相同的評論內(nèi)容時(shí)，可以配置source id來區(qū)分文章（即文章的id）?！?source id#"是您需要配置的部分，如下圖配置owner id當(dāng)您需要

3、使用刪除通知接口時(shí)，需要先配置owner id（即文章所有者的id）?！?owner id#"是您需要配置的部分，如下圖發(fā)布者刪除評論概述對于UGC（如博客等）類網(wǎng)站，當(dāng)內(nèi)容發(fā)布者發(fā)布的內(nèi)容被評論，但是卻想要?jiǎng)h除此評論時(shí)，暢言提供了以下解決方案。在使用前請先配置owner id。具體如何配置，請參考 高級開發(fā)-自定義配置發(fā)布者刪除評論1、刪除評論流程圖如下2、驗(yàn)證接口（需要您提供）描述：用于驗(yàn)證當(dāng)前登錄用戶是否為內(nèi)容發(fā)布者URL： 點(diǎn)擊到后臺設(shè)置中填寫請求方式：GET請求參數(shù)：參數(shù)名類型是否必須說明owner_idStringY內(nèi)容所有者ID-由您提供topic_

4、urlStringN當(dāng)前頁面的URL，和topic_source_id二選其一topic_source_idStringN內(nèi)容ID，和topic_url二選其一-由您提供返回：JSON格式字段名類型說明ownerint有無刪除評論的權(quán)限（1：有權(quán)限，0：無權(quán)限）代碼樣式 "owner": 13、驗(yàn)證刪除信息接口（需要您提供）描述：驗(yàn)證前端發(fā)起的刪除請求是否內(nèi)容所有者發(fā)起URL： 點(diǎn)擊到后臺設(shè)置中填寫請求方式：POST請求參數(shù)：參數(shù)名類型是否必須說明client_idStringYAPP ID-由暢言供owner_idStringY內(nèi)容所有者ID-由您提供topic

5、_idStringY新聞ID暢言IDcomment_idStringY評論ID暢言IDtopic_urlStringN當(dāng)前頁面的URL，和topic_source_id二選其一topic_source_idStringN文章ID，和topic_url二選其一-由您提供返回：JSON格式字段名類型說明successint是否刪除成功（1：刪除成功，0：刪除失?。┐a樣式 "success": 14、刪除評論接口（暢言提供）描述：驗(yàn)證通過后，調(diào)用暢言刪除接口URL：請求方式：POST請求參數(shù)：參數(shù)名類型是否必須說明client_idStringYAPP ID-由暢言供owner

6、_idStringY內(nèi)容所有者ID-由您提供topic_idStringY新聞ID暢言IDcomment_idStringY評論ID暢言IDsignStringY簽名方式為按照所有參數(shù)（除sign參數(shù)外）的字典順序即name=value的形式以&符號鏈接起來，然后使用HmacSha1方式以client_secret作為密鑰進(jìn)行簽名返回。返回：如果成功返回空，失敗返回錯(cuò)誤信息。（JSON格式）字段名類型說明error_codeString錯(cuò)誤碼error_msgString錯(cuò)誤信息發(fā)布者獲取新評論概述對于UGC（如博客等）類網(wǎng)站，當(dāng)內(nèi)容發(fā)布者想獲得發(fā)布的內(nèi)容的新評論列表時(shí)，暢言提供了以下

7、解決方案。在使用前請先配置owner id。具體如何配置，請參考 高級開發(fā)-自定義配置發(fā)布者獲取新評論1、獲得新評論接口描述：獲取內(nèi)容所有者的最新評論列表URL：請求方式：GET請求參數(shù)：參數(shù)名類型是否必須說明client_idStringYAPP ID-由暢言供owner_idStringY內(nèi)容所有者ID-由您提供page_nointN頁數(shù)page_sizeintN每頁條數(shù)callbackStringN回調(diào)接口返回：JSON格式字段名類型說明passportJson對象評論作者commentsJson評論數(shù)組評論列表comment_request_keyString保存評論頂/踩數(shù)

8、key，當(dāng)調(diào)用接口api/open/topic/action時(shí)，傳入此參數(shù)刷新頁面會(huì)立即更新分享數(shù)和喜歡數(shù)topic_request_keyString保存新聞喜歡數(shù)和分享數(shù)的key，當(dāng)調(diào)用接口api/open/comment/action時(shí)，傳入此參數(shù)刷新頁面會(huì)立即更新分享數(shù)和喜歡數(shù)cmt_sumint新聞的評論總數(shù)（包括對評論的回復(fù)）outer_cmt_sumint新聞的直接評論數(shù)（評論翻頁時(shí)使用）代碼樣式 "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": "回復(fù) 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": "回復(fù) 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, /評論總數(shù) "outer_cmt_sum": 150, "participation_sum": 571, /分享數(shù) "like_sum": 35, /喜歡數(shù) "topic_request_key": "loadTopicComments?d77d221a5a83b78b3be3447c720821a8" 單點(diǎn)登錄開發(fā)概述當(dāng)接入暢言的網(wǎng)站有自己的賬號系統(tǒng)時(shí)，想實(shí)現(xiàn)和暢言目前的賬號體系兼容時(shí)，暢言提供以下單點(diǎn)登錄解決方案，達(dá)到的效果為：您的網(wǎng)站和暢言評論框任一方登錄了，另一方自動(dòng)登錄；任

18、一方退出，另一方自動(dòng)退出單點(diǎn)登錄方案1、登錄流程2、退出流程3、登錄接口（需要您提供）描述：用戶在暢言登錄后，暢言調(diào)用此接口，使您的網(wǎng)站同步登錄URL： 點(diǎn)擊到后臺設(shè)置中填寫請求方式：GET請求參數(shù)：參數(shù)如下參數(shù)名類型是否必須說明cy_user_idintY暢言uidnicknameStringY暢言用戶的昵稱，長度小于1023個(gè)字節(jié)（如果為空則傳空字符串）。img_urlStringY暢言用戶的頭像，長度小于1023個(gè)字節(jié)（如果為空則傳空字符串）。profile_urlStringY暢言用戶的個(gè)人中心地址，長度小于1023個(gè)字節(jié)（如果為空則傳空字符串）。user_idStringY

19、第三方接入網(wǎng)站的用戶idsignStringY參數(shù)簽名信息。簽名方式為按照所有參數(shù)(除sign參數(shù)外)的字典順序即name=value的形式以&符號鏈接起來，然后以client_secret作為密鑰進(jìn)行用HMACSHA1算法進(jìn)行簽名）isv應(yīng)該對所有入?yún)ⅲǔ齭ign外）計(jì)算簽名，然后與此參數(shù)進(jìn)行比較，以防止參數(shù)被篡改。callbackStringY回調(diào)函數(shù)返回：Jsonp格式，返回參數(shù)如下參數(shù)名類型說明user_idString長度小于100個(gè)字節(jié)，登錄失敗返回空字符串返回代碼示例：假設(shè)參數(shù)callback的值為"aaa"aaa(user_id : "21

20、315")4、獲取用戶信息接口（需要您提供）描述：暢言調(diào)用此接口，查詢是否有用戶登錄（若有則暢言實(shí)現(xiàn)同步登錄）URL： 點(diǎn)擊到后臺設(shè)置中填寫請求方式：GET請求參數(shù)：參數(shù)如下參數(shù)名類型是否必須說明callbackStringY回調(diào)函數(shù)返回：Jsonp格式，返回參數(shù)如下參數(shù)名類型說明cy_user_idint暢言uidnicknameString第三方接入網(wǎng)站用戶的昵稱，長度小于63個(gè)字節(jié)（如果為空則傳空字符串）。img_urlString第三方接入網(wǎng)站用戶的頭像，長度小于1023個(gè)字節(jié)（如果為空則傳空字符串）。profile_urlString第三方接入網(wǎng)站用戶的個(gè)人中心地

21、址，長度小于1023個(gè)字節(jié)（如果為空則傳空字符串）。user_idString第三方接入網(wǎng)站的用戶id，長度小于100個(gè)字節(jié)（如果為空則傳空字符串）is_loginint用戶是否登錄標(biāo)志 0表示未登錄，1表示已登錄（登錄需要返回user對象）signString參數(shù)簽名信息。簽名方式為按照所有參數(shù)(除sign參數(shù)外)的字典順序即name=value的形式以&符號鏈接起來，然后以client_secret作為密鑰進(jìn)行用HMACSHA1算法進(jìn)行簽名）isv應(yīng)該對所有入?yún)ⅲǔ齭ign外）計(jì)算簽名，然后與此參數(shù)進(jìn)行比較，以防止參數(shù)被篡改。callbackString回調(diào)函數(shù)返回代碼示例：已登錄

22、用戶，假設(shè)參數(shù)callback的值為"aaa" aaa( "is_login ": 1,"user": "img_url": ""nickname": "aaas","profile_url": "","user_id": 42417,"cy_user_id":"23243","sign":"werdfasdfasdf")返回代

23、碼示例：未登錄用戶,假設(shè)參數(shù)callback的值為"aaa"aaa("is_login ": 0)5、用戶退出接口（由您提供）描述：當(dāng)暢言退出時(shí)，調(diào)用此接口，實(shí)現(xiàn)用戶在您的網(wǎng)站退出URL： 點(diǎn)擊到后臺設(shè)置中填寫請求方式：GET請求參數(shù)：參數(shù)如下參數(shù)名類型是否必須說明codeintY0退出失敗，1退出成功callbackStringY回調(diào)函數(shù)返回：Jsonp格式，返回參數(shù)如下參數(shù)名類型說明codeint0退出失敗，1退出成功返回代碼示例：假設(shè)參數(shù)callback的值為"aaa"aaa("code"：1)6、

24、暢言退出接口（由暢言提供）描述：當(dāng)用戶單點(diǎn)登錄成功后，用戶在第三方退出時(shí)，第三方需要調(diào)用暢言的退出接口，以通知暢言也讓此用戶在暢言退出。URL：請求方式：GET請求參數(shù)：參數(shù)如下參數(shù)名類型是否必須說明callbackStringY回調(diào)函數(shù)返回格式：Jsonp格式參數(shù)名類型說明codeint0退出失敗，1退出成功返回代碼示例：假設(shè)參數(shù)callback的值為"aaa"aaa("code"：1)Oauth認(rèn)證Oauth2.01、Oauth2.0概述Oauth2.0認(rèn)證框架提供了第三方應(yīng)用的認(rèn)證流程，第三方應(yīng)用可以通過HTTP服務(wù)獲得有限的資源訪問權(quán)限，即第三方

25、應(yīng)用可以通過該協(xié)議獲取訪問暢言系統(tǒng)部分資源的權(quán)限。通過該認(rèn)證方式保證用戶的密碼不會(huì)泄露給第三方應(yīng)用，同時(shí)用戶還可以選擇性地授權(quán)第三方應(yīng)用訪問用戶自己有限的信息。2、Oauth2.0流程暢言O(shè)auth2.01、暢言O(shè)auth2.0概述由于暢言支持社會(huì)化登錄，所以授權(quán)相對復(fù)雜些。在使用前請先申請client_id與client_secre。暢言開放平臺的Oauth2.0認(rèn)證框架支持的認(rèn)證方式為：授權(quán)碼(Authorization Code)認(rèn)證。第三方應(yīng)用首先通過client_id和RedirectUri引導(dǎo)用戶進(jìn)入暢言平臺的認(rèn)證接口，當(dāng)用戶認(rèn)證成功后會(huì)通過HTTP Redirect的方式將該Co

26、de傳遞給第三方提供的Redirect Uri。然后第三方通過該Authorization Code和自己申請到的client_secret向暢言服務(wù)器請求獲取AccessToken，如果全部成功則暢言服務(wù)器返回一個(gè)AccessToken給第三方。之后第三方就可以通過該AccessToken訪問暢言系統(tǒng)的OAuth API。暢言平臺的Oauth2.0暫不支持RefreshToken的策略。2、暢言O(shè)auth2.0流程3、獲取AuthorizationCode接口名：/api/oauth2/authorizeURL：請求方式：GET請求參數(shù)：參數(shù)名類型是否必須說明client_idStringY

27、暢言appIdredirect_uriStringY授權(quán)回調(diào)地址，必須和用戶注冊時(shí)填的一致response_typeStringY響應(yīng)類型,必須為codescopeStringN用戶授權(quán)時(shí)向用戶顯示的可進(jìn)行授權(quán)的列表platform_idlongNplatform_id可取>0(具體的第三方登錄頁 2為新浪、3為qq、4為騰訊微博、5為網(wǎng)易微博、6為人人、7為百度、8為豆瓣、11為搜狐Passport)、默認(rèn)（游客和第三方）stateStringNclient端的狀態(tài)值,用于第三方應(yīng)用防止CSRF攻擊，成功授權(quán)后回調(diào)時(shí)會(huì)原樣帶回。displayStringN授權(quán)頁面的終端類型，取值見下面

28、的說明。（default默認(rèn)的授權(quán)頁面，適用于web瀏覽器；mobile指移動(dòng)設(shè)備）。scopeStringN用戶授權(quán)時(shí)向用戶顯示的可進(jìn)行授權(quán)的列表返回：字段名類型說明CodeString用戶授權(quán)的codeStateString如果請求時(shí)傳遞了state參數(shù)，會(huì)回傳該參數(shù)代碼樣式請求授權(quán)code& response_type=code&platform_id=-1如果授權(quán)成功，暢言授權(quán)服務(wù)器會(huì)將用戶瀏覽器重定向到redirect_uri第三方應(yīng)用（ISV）獲取到暢言授權(quán)的code（code有效期為10分鐘，且只能使用一次）之后，就可以使用此code調(diào)用/api/oauth2/t

29、oken接口，換取用戶授權(quán)的access_token。4、獲取AccessToken接口名：/api/oauth2/tokenURL：請求方式：POST請求參數(shù)：參數(shù)名類型是否必須說明client_idStringY暢言appIdclient_secretStringYappKeygrant_typeStringY響應(yīng)類型（可以為authorization_code、password、refresh_token），當(dāng)前只支持authorization_codecodeStringN授權(quán)接口返回的授權(quán)碼（當(dāng)參數(shù)grant_type值為authorization_code必填)redirect_u

30、riStringN回調(diào)地址（當(dāng)參數(shù)grant_type值為authorization_code必填）refresh_tokenStringN用于刷新的refresh_token（當(dāng)參數(shù)grant_type值為refresh_token必填）返回：字段名類型說明access_tokenString訪問暢言用戶資源的憑證，調(diào)用開放接口時(shí)需要expires_inlongaccess_token的失效時(shí)間，單位為秒代碼樣式"access_token": "10000|5.a6b7dbd428f731035f771b8d15063f61.86400.1292922000-2

31、22209506","expires_in": 87063分類接口接口說明基本接口api/open/topic/load加載文章的評論列表。根據(jù)文章topic_source_id或者URL獲取文章id(topic_id)，并返回第一頁評論信息api/open/comment/list通過分頁方式獲得評論數(shù)據(jù)api/open/user/info獲取登錄用戶的信息(包括綁定的賬號）api/open/user/comment/submit發(fā)表評論并分享到第三方分類接口接口說明用戶接口api/open/user/passport/unbinding解除用戶（某個(gè)賬號）的綁

32、定api/oauth2/binding綁定（第三方開放平臺賬號到當(dāng)前登錄）用戶評論接口api/open/user/comment/share只分享評論（到第三方開放平臺）api/open/user/comment/reply獲取用戶收到的最新回復(fù)列表api/open/comment/reply獲取某個(gè)評論的回復(fù)列表api/opentopic/comment/sum獲取文章評論總數(shù)api/open/topic/info獲取文章的新聞評論數(shù)、參與數(shù)、喜歡數(shù)api/open/user/attachment/add上傳圖片喜歡接口api/open/topic/action喜歡（文章）頂踩接口api/o

33、pen/comment/action頂/踩（回復(fù)）錯(cuò)誤代碼概述當(dāng)接入方調(diào)用開放API出現(xiàn)錯(cuò)誤時(shí)，返回相應(yīng)的錯(cuò)誤代碼。錯(cuò)誤代碼由五位數(shù)字組成，從左到右，第一數(shù)字表示服務(wù)級錯(cuò)誤，第二位和第三位表示服務(wù)模塊代碼，第四位和第五位表示具體錯(cuò)誤代碼第一數(shù)字第二、三個(gè)數(shù)字第四、五個(gè)數(shù)字服務(wù)級錯(cuò)誤（1為業(yè)務(wù)錯(cuò)誤，2為權(quán)限錯(cuò)誤）服務(wù)模塊代碼具體錯(cuò)誤代碼業(yè)務(wù)錯(cuò)誤1、服務(wù)模塊錯(cuò)誤代碼錯(cuò)誤代碼錯(cuò)誤類型00通用錯(cuò)誤01主體02用戶2、具體業(yè)務(wù)錯(cuò)誤代碼錯(cuò)誤代碼錯(cuò)誤類型10000系統(tǒng)內(nèi)部錯(cuò)誤10001非法的請求參數(shù)10002驗(yàn)證碼錯(cuò)誤10100文章url或者文章id為空10200不能解綁當(dāng)前登錄用戶10201不能主動(dòng)綁定來

34、自同一平臺的2個(gè)用戶10202同一平臺用戶綁定數(shù)不能超過5個(gè)10203游客昵稱包含非法詞10204游客昵稱或郵箱長度過長10205解綁的賬號不屬于沒有與登錄用戶過權(quán)限錯(cuò)誤1、服務(wù)模塊錯(cuò)誤代碼錯(cuò)誤代碼錯(cuò)誤類型00通用錯(cuò)誤01Oauth授權(quán)驗(yàn)證02頻率控制2、具體業(yè)務(wù)錯(cuò)誤代碼錯(cuò)誤代碼錯(cuò)誤類型20000Oauth授權(quán)驗(yàn)證異常20101code過期20102code非法20103code重復(fù)使用20104token過期20105token非法20106簽名錯(cuò)誤20107非法的client_id20108redirect_uri非法20109參數(shù)response_type必須為code20110參數(shù)gr

35、ant_type必須為authorization_code20111缺少Oauth授權(quán)參數(shù)20112參數(shù)nonce的值重復(fù)使用數(shù)據(jù)導(dǎo)出概述暢言提供了數(shù)據(jù)導(dǎo)出功能，用戶可以根據(jù)自己的需要導(dǎo)出特定時(shí)間段的數(shù)據(jù),不包括刪除的評論,不包括刪除的評論導(dǎo)出數(shù)據(jù)的格式說明參數(shù)名類型說明successboolean數(shù)據(jù)是否導(dǎo)出成功messageString錯(cuò)誤信息，導(dǎo)出失敗時(shí)提示commentsJSON評論數(shù)組評論列表topicUrlString文章URLtopicTitleString文章標(biāo)題topicIdlong文章IDsourceTopicIdString文章的原始IDtopicLikeSumlong文

36、章的被喜歡數(shù)topickShareSumlong文章被分享數(shù)cmtIdlong評論IDcontentString評論內(nèi)容attachsJson數(shù)組圖片評論ctimeDate評論發(fā)表時(shí)間splong評論被頂次數(shù)oplong評論被踩次數(shù)replyIdlong所回復(fù)的評論的ID，為0表示沒有回復(fù)其他評論nicknameString用戶昵稱fromString用戶賬號來源iconUrlString用戶頭像(如果為空，表示使用默認(rèn)頭像）userProfileUrlString用戶個(gè)人主頁代碼樣式 "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:/