糖果SNS-API-REST規(guī)范接口

文檔修改記錄.糖果糖果SNS-APIREST規(guī)范接口API接口文檔Version1.0項(xiàng)目名稱：項(xiàng)目名稱：糖果SNS-API-REST規(guī)范接口項(xiàng)目支持部門：SDO-OA產(chǎn)品部項(xiàng)目負(fù)責(zé)人：余偉作者姓名：楊揚(yáng)定稿日期：2010-9-文檔修改記錄序號(hào)版本修改者主要修改內(nèi)容日期1V1.0楊揚(yáng)初稿2010-9-2 目錄目錄1 REST規(guī)范接口 61.1 API的ULR 62 auth.createToken 62.1 描述 62.2 參數(shù)表 62.3 成功返回的完整XML例子 62.4 成功返回的完整JSON例子 63 auth.getSession 73.1 描述 73.2 參數(shù)表 73.3 成功返回的完整XML例子 73.4 成功返回的完整JSON例子 74 feed.publishTemplatizedAction 74.1 描述 84.2 參數(shù)表 84.3 成功返回的完整XML例子 84.4 成功返回的完整JSON例子 85 friends.areFriends 95.1 描述 95.2 參數(shù)表 95.3 成功返回的完整XML例子 95.4 成功返回的完整JSON例子 106 friends.get 106.1 描述 106.2 參數(shù)表 106.3 成功返回的完整XML例子 116.4 成功返回的完整JSON例子 117 friends.getFriends 117.1 描述 117.2 參數(shù)表 117.3 成功返回的完整XML例子 127.4 成功返回的完整JSON例子 127.5 XML節(jié)點(diǎn)解釋 138 friends.getAppFriends 138.1 描述 138.2 參數(shù)表 138.3 成功返回的完整XML例子 138.4 成功返回的完整JSON例子 148.5 XML節(jié)點(diǎn)解釋 149 users.getInfo 149.1 描述 149.2 參數(shù)表 159.3 成功返回的完整XML例子 159.4 成功返回的完整JSON例子 159.5 XML節(jié)點(diǎn)解釋 1610 users.getLoggedInUser 1610.1 描述 1610.2 參數(shù)表 1610.3 成功返回的完整XML例子 1710.4 成功返回的完整JSON例子 1711 users.isAppUser 1711.1 描述 1711.2 參數(shù)表 1711.3 成功返回的完整XML例子 1711.4 成功返回的完整JSON例子 1812 invitations.createLink 1812.1 描述 1812.2 參數(shù)表 1812.3 成功返回的完整XML例子 1812.4 成功返回的完整JSON例子 1913 invitations.send 1913.1 描述 1913.2 參數(shù)表 1913.3 成功返回的完整XML例子 1913.4 成功返回的完整JSON例子 2014 notifications.send 2014.1 描述 2014.2 參數(shù)表 2014.3 成功返回的完整XML例子 2014.4 成功返回的完整JSON例子 21 正文REST規(guī)范接口API的ULR\o"/restserver.php"/restserver.phpauth.createToken描述生成一個(gè)token作為Auth.getSession下的一個(gè)參數(shù)，在用戶完成登錄以后調(diào)用Auth.getSession得到一個(gè)session_key，適用站外應(yīng)用。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringAuth.createTokencall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。成功返回的完整XML例子成功返回的完整JSON例子auth.getSession描述生成一個(gè)用戶的session_key，適用站外應(yīng)用。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringAuth.getSessioncall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0tokenstring由auth.createToken生成的token號(hào)。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。成功返回的完整XML例子成功返回的完整JSON例子feed.publishTemplatizedAction描述生給當(dāng)前登錄者的好友且安裝了同樣應(yīng)用的用戶發(fā)新鮮事。現(xiàn)有發(fā)送規(guī)則為2天內(nèi)每個(gè)用戶只能發(fā)送10條新鮮事模板中不允許除<a>外的其他html標(biāo)記。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringfeed.publishTemplatizedActioncall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期template_idint注冊的Feed模板Id，必須是真正注冊的Feed模板，可以參考“注冊Feed模板”body_datastring此項(xiàng)為JSON格式的數(shù)組，如果你在定義新鮮事模板的“Feed標(biāo)題”時(shí)，自定義了一些變量（如Feed標(biāo)題：{actor}完成了問卷{title}得分{mark}），那么你必須在此項(xiàng)中為這些變量賦值，例如此項(xiàng)值為：{"actor":"wolfhead","title":"語文課","mark":"90"}，不允許任何html標(biāo)簽。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。成功返回的完整XML例子成功返回的完整JSON例子friends.areFriends描述判斷兩組用戶是否互為好友關(guān)系，比較的兩組用戶數(shù)必須相等。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringfriends.areFriendscall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期uid1string第一組用戶的ID，每個(gè)ID之間以逗號(hào)分隔。uid2string第二組用戶的ID，每個(gè)ID之間以逗號(hào)分隔。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。成功返回的完整XML例子成功返回的完整JSON例子friends.get描述生得到當(dāng)前登錄用戶的好友列表，得到的只是含有好友uid的列表。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringFriends.getcall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。pageint分頁，默認(rèn)為0。countint返回每頁個(gè)數(shù)，默認(rèn)為50。成功返回的完整XML例子成功返回的完整JSON例子friends.getFriends描述得到當(dāng)前登錄用戶的好友列表。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringFriends.getFriendscall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。pageint分頁，默認(rèn)為0。countint返回每頁個(gè)數(shù)，默認(rèn)為50。成功返回的完整XML例子成功返回的完整JSON例子XML節(jié)點(diǎn)解釋NameDescription<id>用戶id<name>用戶名<tinyurl>用戶小頭像路徑<headurl>用戶中等頭像路徑friends.getAppFriends描述返回App好友的ID列表。App好友是指某個(gè)用戶安裝了同一應(yīng)用的好友。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringfriends.areFriendscall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。fieldsstring返回的字段列表，可以指定返回那些字段，用逗號(hào)分隔。目前支持name（姓名）、tinyurl(小頭像)、headurl（中等頭像），如果不傳遞此參數(shù)，默認(rèn)返回好友id節(jié)點(diǎn)。成功返回的完整XML例子成功返回的完整JSON例子XML節(jié)點(diǎn)解釋NameDescription<id>用戶id<name>用戶名<tinyurl>用戶小頭像路徑<headurl>用戶中等頭像路徑users.getInfo描述得到用戶信息，當(dāng)對方設(shè)置了隱私權(quán)限，只能返回用戶的姓名（name）、性別（sex）、頭像（headurl）等數(shù)據(jù)。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringUsers.getInfocall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。fieldsstring返回的字段列表，可以指定返回那些字段，用逗號(hào)分隔。目前支持name（姓名）、tinyurl(小頭像)、headurl（中等頭像），如果不傳遞此參數(shù)，默認(rèn)返回好友id節(jié)點(diǎn)。uidsstring需要查詢的用戶的id成功返回的完整XML例子成功返回的完整JSON例子XML節(jié)點(diǎn)解釋NameDescription<id>用戶id<name>用戶名<tinyurl>用戶小頭像路徑<headurl>用戶中等頭像路徑users.getLoggedInUser描述得到當(dāng)前session的用戶ID，返回的ID值應(yīng)該在session有效期內(nèi)被存儲(chǔ)，從而避免重復(fù)地調(diào)用該方法。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringUsers.getLoggedInUsercall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。成功返回的完整XML例子成功返回的完整JSON例子users.isAppUser描述判斷用戶是否已經(jīng)對應(yīng)用授權(quán)。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringfriends.areFriendscall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0session_keystring登錄用戶的sessionkey.用于驗(yàn)證是否為當(dāng)前用戶發(fā)出的請求，如果出現(xiàn)SessionKey過期的情況請參考關(guān)于session_key過期。optionalformatstringResponse的格式,XML或者JSON，缺省值為JSON。成功返回的完整XML例子成功返回的完整JSON例子invitations.createLink描述生成用戶站外邀請用戶注冊的鏈接地址,應(yīng)用可以引導(dǎo)用戶通過QQ或者msn等渠道邀請好友加入應(yīng)用。參數(shù)表RequiredNameTypeDescriptionrequiredapi_keystring申請應(yīng)用時(shí)分配的api_key，調(diào)用接口時(shí)候代表應(yīng)用的唯一身份。methodstringinvitations.createLinkcall_idfloat當(dāng)前調(diào)用請求隊(duì)列號(hào)，建議使用當(dāng)前系統(tǒng)時(shí)間戳。sigstring它是由當(dāng)前請求參數(shù)和secretKey的一個(gè)MD5值。vstringAPI的版本號(hào)，請?jiān)O(shè)置成1.0se