產(chǎn)品控制中心+-+授權(quán)接口文檔

1、基礎(chǔ)對象模型 版本歷史版本更新日期更新內(nèi)容更新人1.02009-11-10初始版本高良1.12009-11-141. 六個(gè)接口對服務(wù)授權(quán)是否存在，使用關(guān)系是否存在的判斷變更2. 去掉使用關(guān)系表中服務(wù)授權(quán)ID字段3. 記錄服務(wù)授權(quán)日志與業(yè)務(wù)同步執(zhí)行高良1.22009-11-231. 原接口參數(shù)和返回值都為POJO，現(xiàn)在改為HashMap2. 當(dāng)請求時(shí)間在上次服務(wù)時(shí)間之前或相等時(shí)，增加服務(wù)授權(quán)已過期的信息提示（1002） 詳見附表高良1.32009-11-241. 產(chǎn)品控制中心所有返回代碼前都加1例 1000 à 11000高良1. 產(chǎn)品控制中心授權(quán)接口1.1增加使用者調(diào)用形式：Hess

2、ian提供方： 產(chǎn)品中心調(diào)用方： 產(chǎn)品端接口名稱：增加使用者接口：com.alibaba.bss.pc2.server.remoting.IAuthorizeControllerService方法：public HashMap addUserPermission(HashMap paramMap);接口描述：產(chǎn)品端增加使用者對指定產(chǎn)品功能項(xiàng)的使用功能，產(chǎn)品中心為使用者開通授權(quán)服務(wù)注意：產(chǎn)品端在實(shí)現(xiàn)邀請用戶業(yè)務(wù)時(shí)，也調(diào)用此接口，其中產(chǎn)品編號參數(shù)填寫 基礎(chǔ)產(chǎn)品編號接口時(shí)序圖：接口參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空addUserParam對象addUserParamObject提供給產(chǎn)品端的接

3、口的參數(shù)對象NaddUserParam對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString需要增加的產(chǎn)品編號N使用者列表userIdListList增加的使用者uid列表N接口返回對象：名稱類型說明resultboolean成功:true失敗:falseerrorCodeString錯(cuò)誤代碼11000 : 成功11001: 使用關(guān)系已存在12001 : addUserParam對象參數(shù)錯(cuò)誤12002 : vaccountId參數(shù)錯(cuò)誤12003 : 產(chǎn)品編號參數(shù)錯(cuò)誤12004 : 使用者列表參數(shù)錯(cuò)

4、誤13001 : 服務(wù)授權(quán)不存在19001 : 系統(tǒng)異常errorInfoString錯(cuò)誤詳細(xì)信息通知計(jì)費(fèi)中心的參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString通知計(jì)費(fèi)的產(chǎn)品編號N授權(quán)用戶數(shù)userCountString服務(wù)授權(quán)記錄對應(yīng)的開通狀態(tài)的使用關(guān)系數(shù)量N操作時(shí)間gmtOperateDate產(chǎn)品控制中心記錄的授權(quán)時(shí)間N接口調(diào)用流程說明:1. 當(dāng)產(chǎn)品端調(diào)用此接口增加使用者時(shí)，通過vaccountId和產(chǎn)品編號取得服務(wù)授權(quán)記錄2. 若服務(wù)授權(quán)記錄不存在，返回錯(cuò)誤信息3. 查找使用關(guān)系記錄，若已

5、存在會(huì)有提示，但不報(bào)錯(cuò)，狀態(tài)更新為開通4. 若不存在使用關(guān)系則新增5. 記錄授權(quán)日志6. 將使用關(guān)系數(shù)據(jù)同步到產(chǎn)品中心的cache中7. 通知產(chǎn)品端，服務(wù)授權(quán)成功8. 計(jì)算開通的授權(quán)用戶數(shù)9. 通知計(jì)費(fèi)中心授權(quán)用戶數(shù)1.2刪除使用者調(diào)用形式：Hessian提供方： 產(chǎn)品中心調(diào)用方： 產(chǎn)品端接口名稱：刪除使用者接口：com.alibaba.bss.pc2.server.remoting.IAuthorizeControllerService方法：public HashMap delUserPermission(HashMap paramMap);接口描述：客戶會(huì)對某付費(fèi)產(chǎn)品刪除使用者，產(chǎn)品控制中

6、心刪除使用者對指定產(chǎn)品功能項(xiàng)授權(quán)注意：產(chǎn)品端在實(shí)現(xiàn)刪除用戶業(yè)務(wù)時(shí)，也調(diào)用此接口，其中產(chǎn)品編號參數(shù)填寫 基礎(chǔ)產(chǎn)品編號接口時(shí)序圖：接口參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空delUserParam對象delUserParamObject接口所需參數(shù)實(shí)體NdelUserParam對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString需要?jiǎng)h除的產(chǎn)品編號N使用者列表userIdListList增加的使用者uid列表N接口返回對象：名稱類型說明resultboolean成功:true失敗:falseerro

7、rCodeString錯(cuò)誤代碼11000 : 成功11001：使用關(guān)系不存在12001 : delUserParam對象參數(shù)錯(cuò)誤12002 : vaccountId參數(shù)錯(cuò)誤12003 : 產(chǎn)品編號參數(shù)錯(cuò)誤12004 : 使用者列表參數(shù)錯(cuò)誤13001 : 服務(wù)授權(quán)不存在19001 : 系統(tǒng)異常errorInfoString錯(cuò)誤詳細(xì)信息通知計(jì)費(fèi)中心的參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString通知計(jì)費(fèi)的產(chǎn)品編號N授權(quán)用戶數(shù)userCountString服務(wù)授權(quán)記錄對應(yīng)的開通狀態(tài)的使用關(guān)系數(shù)量N操

8、作時(shí)間gmtOperateDate產(chǎn)品控制中心記錄的授權(quán)時(shí)間N接口調(diào)用流程說明:1. 當(dāng)產(chǎn)品端調(diào)用此接口刪除使用者時(shí)，通過vaccountId和產(chǎn)品編號取得服務(wù)授權(quán)記錄2. 若服務(wù)授權(quán)記錄不存在，返回錯(cuò)誤信息3. 查找使用關(guān)系記錄，若不存在會(huì)有提示，但不報(bào)錯(cuò)4. 刪除相應(yīng)的使用關(guān)系記錄5. 記錄授權(quán)日志6. 將使用關(guān)系數(shù)據(jù)同步到產(chǎn)品中心的cache中7. 通知產(chǎn)品端，關(guān)閉服務(wù)授權(quán)成功 8. 計(jì)算開通的授權(quán)用戶數(shù)9. 通知計(jì)費(fèi)中心授權(quán)用戶數(shù)1.3開通服務(wù)調(diào)用形式：Hessian提供方： 產(chǎn)品中心調(diào)用方： 訂單系統(tǒng)接口名稱：開通服務(wù)接口：com.alibaba.bss.pc2.server.rem

9、oting.IAuthorizeControllerService方法：public HashMap openService(ArrayList paramMapList);接口描述：客戶自助開通產(chǎn)品服務(wù)時(shí)，訂單系統(tǒng)調(diào)用此接口，產(chǎn)品中心為客戶開通相應(yīng)產(chǎn)品功能的授權(quán)接口時(shí)序圖：接口參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空List<openPerParam>openPerParamListList接口所需參數(shù)實(shí)體列表NopenPerParam對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空授權(quán)使用標(biāo)識permissionJsonjson開通服務(wù)時(shí)需要的業(yè)務(wù)參數(shù)組合成的json對象N產(chǎn)品編號

10、productCodeString產(chǎn)品編號NvaccountIdvaccountIdString虛擬帳號IDN來源sourceString值域枚舉1：（訂單系統(tǒng)）N業(yè)務(wù)IDbusinessIdString訂單行號Y備注commentsString“開通服務(wù)”Y授權(quán)時(shí)間gmtAuthorizeDate授權(quán)時(shí)間YpermissionJson對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空使用者列表userIdListpermissionJsonList自助開通的使用者列表格式"permissionJson":"userId1","userId2&quo

11、t;Y接口返回對象：名稱類型說明resultboolean成功:true失敗:falseerrorCodeString錯(cuò)誤代碼11000 : 成功11001：服務(wù)授權(quán)已開通11002: 服務(wù)授權(quán)已過期12001 : openPerParamList參數(shù)錯(cuò)誤12002 : 產(chǎn)品編號參數(shù)錯(cuò)誤12003 : vaccountId參數(shù)錯(cuò)誤12004 : 來源參數(shù)錯(cuò)誤 12005 : 業(yè)務(wù)ID參數(shù)錯(cuò)誤 12006 : 備注參數(shù)錯(cuò)誤12007 : 授權(quán)使用標(biāo)識參數(shù)錯(cuò)誤9001 : 系統(tǒng)異常errorInfoString錯(cuò)誤詳細(xì)信息通知計(jì)費(fèi)中心的參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdv

12、accountIdString虛擬帳號IDN產(chǎn)品編號productCodeString通知計(jì)費(fèi)的產(chǎn)品編號N授權(quán)用戶數(shù)userCountString服務(wù)授權(quán)記錄對應(yīng)的開通狀態(tài)的使用關(guān)系數(shù)量N操作時(shí)間gmtOperateDate產(chǎn)品控制中心記錄的授權(quán)時(shí)間N接口調(diào)用流程說明:1. 當(dāng)訂單系統(tǒng)調(diào)用此接口時(shí)，若使用者列表參數(shù)為空，則不增加使用關(guān)系2. 為此vaccountId創(chuàng)建服務(wù)授權(quán)記錄（若已存在且為開通的狀態(tài)，則會(huì)有提示，但不報(bào)錯(cuò)）3. 為所有使用者創(chuàng)建使用關(guān)系記錄（若已存在且為開通的狀態(tài)，則會(huì)有提示，但不報(bào)錯(cuò)）4. 記錄授權(quán)日志5. 將使用關(guān)系數(shù)據(jù)同步到產(chǎn)品中心的cache中6. 返回通知產(chǎn)品端

13、，服務(wù)授權(quán)成功 7. 通知計(jì)費(fèi)中心授權(quán)用戶數(shù)1.4暫停服務(wù)調(diào)用形式：Hessian提供方： 產(chǎn)品中心調(diào)用方： 訂單系統(tǒng)and計(jì)費(fèi)中心接口名稱：暫停服務(wù)接口：com.alibaba.bss.pc2.server.remoting.IAuthorizeControllerService方法：public HashMap pauseService(ArrayList paramMapList);接口描述：訂單系統(tǒng)：用戶在產(chǎn)品端主動(dòng)暫停付費(fèi)產(chǎn)品，訂單系統(tǒng)會(huì)通知產(chǎn)品控制中心，產(chǎn)品控制中心更新服務(wù)授權(quán)計(jì)費(fèi)中心：公司欠費(fèi)一段時(shí)間后，計(jì)費(fèi)中心會(huì)通知產(chǎn)品控制中心關(guān)閉服務(wù)，產(chǎn)品控制中心關(guān)閉服務(wù)授權(quán)注意：計(jì)費(fèi)中心欠

14、費(fèi)關(guān)閉也調(diào)用此接口，在source參數(shù)中請調(diào)用方按枚舉填寫接口時(shí)序圖：接口參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空List<pausePerParam> pausePerParamListList接口所需參數(shù)實(shí)體列表NpausePerParam對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString需要暫停的產(chǎn)品編號N業(yè)務(wù)IDbusinessIdString訂單行號或帳單明細(xì)IDY備注commentsString其它說明“自助暫?！?，“欠費(fèi)關(guān)閉”Y暫停時(shí)間gmtAuthorizeDate

15、訂單系統(tǒng)掛起時(shí)間(用于記錄到授權(quán)日志)計(jì)費(fèi)中心可傳欠費(fèi)關(guān)閉時(shí)間Y來源sourceString值域枚舉1：（訂單系統(tǒng)） 2：（計(jì)費(fèi)中心）N接口返回對象：名稱類型說明resultboolean成功:true失敗:falseerrorCodeString錯(cuò)誤代碼11000 : 成功11001 : 服務(wù)授權(quán)已暫停11002: 服務(wù)授權(quán)已過期12001 : pausePerParamList參數(shù)錯(cuò)誤12002 : vaccountId參數(shù)錯(cuò)誤12003 : 產(chǎn)品編號參數(shù)錯(cuò)誤12004 : 來源參數(shù)錯(cuò)誤12005 : 業(yè)務(wù)ID參數(shù)錯(cuò)誤12006 : 備注參數(shù)錯(cuò)誤13001：服務(wù)授權(quán)不存在19001 : 系

16、統(tǒng)異常errorInfoString錯(cuò)誤詳細(xì)信息接口調(diào)用流程說明:1. 當(dāng)訂單系統(tǒng)調(diào)用此接口暫停服務(wù)時(shí)通過vaccountId和產(chǎn)品編號取得服務(wù)授權(quán)記錄2. 若服務(wù)授權(quán)不存在，返回錯(cuò)誤信息3. 更新服務(wù)授權(quán)記錄，狀態(tài)變?yōu)殛P(guān)閉4. 更新所有相應(yīng)的使用關(guān)系記錄5. 記錄授權(quán)日志6. 將使用關(guān)系數(shù)據(jù)同步到產(chǎn)品中心的cache中7. 通知產(chǎn)品端，服務(wù)授權(quán)暫停成功8. 通知計(jì)費(fèi)中心授權(quán)用戶數(shù)1.4恢復(fù)服務(wù)調(diào)用形式：Hessian提供方： 產(chǎn)品中心調(diào)用方： 訂單系統(tǒng)and計(jì)費(fèi)中心接口名稱：恢復(fù)服務(wù)接口：com.alibaba.bss.pc2.server.remoting.IAuthorizeContro

17、llerService方法：public HashMap reopenService(ArrayList paramMapList);接口描述：用戶在產(chǎn)品端再次恢復(fù)之前目前被暫停的付費(fèi)產(chǎn)品服務(wù)，訂單系統(tǒng)會(huì)通知產(chǎn)品控制中心，產(chǎn)品控制中心更新服務(wù)授權(quán)計(jì)費(fèi)中心：公司欠費(fèi)被關(guān)閉服務(wù)，通過充值足夠金額，銷賬成功后，計(jì)費(fèi)中心通知產(chǎn)品控制中心開通服務(wù)注意：計(jì)費(fèi)中心欠費(fèi)關(guān)閉也調(diào)用此接口，在source參數(shù)中請調(diào)用方按枚舉填寫接口時(shí)序圖：接口參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空List<reopenPerParam> reopenPerParamListList接口所需參數(shù)實(shí)體NreopenPe

18、rParam對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString需要暫停的產(chǎn)品編號N業(yè)務(wù)IDbusinessIdString訂單行號或，帳單明細(xì)IDY備注commentsString其它說明Y授權(quán)時(shí)間gmtAuthorizeDate授權(quán)時(shí)間Y來源sourceString值域枚舉1：（訂單系統(tǒng)） 2：（計(jì)費(fèi)中心）N接口返回對象：名稱類型說明resultboolean成功:true失敗:falseerrorCodeString錯(cuò)誤代碼11000 : 成功11001 : 服務(wù)授權(quán)已開通11002: 服

19、務(wù)授權(quán)已過期12001 : reopenPerParamList參數(shù)錯(cuò)誤12002 : vaccountId參數(shù)錯(cuò)誤12003 : 產(chǎn)品編號參數(shù)錯(cuò)誤12004: 來源參數(shù)錯(cuò)誤12005 : 業(yè)務(wù)ID參數(shù)錯(cuò)誤12006 : 備注參數(shù)錯(cuò)誤13001：服務(wù)授權(quán)不存在19001 : 系統(tǒng)異常errorInfoString錯(cuò)誤詳細(xì)信息通知計(jì)費(fèi)中心的參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString通知計(jì)費(fèi)的產(chǎn)品編號N授權(quán)用戶數(shù)userCountString服務(wù)授權(quán)記錄對應(yīng)的開通狀態(tài)的使用關(guān)系數(shù)量N操作時(shí)間g

20、mtOperateDate產(chǎn)品控制中心記錄的授權(quán)時(shí)間N接口調(diào)用流程說明:1. 當(dāng)訂單系統(tǒng)調(diào)用此接口恢復(fù)服務(wù)時(shí)通過vaccountId和產(chǎn)品編號取得服務(wù)授權(quán)記錄2. 若服務(wù)授權(quán)不存在，返回錯(cuò)誤信息3. 更新服務(wù)授權(quán)記錄4. 更新所有相應(yīng)的關(guān)閉狀態(tài)的使用關(guān)系記錄5. 記錄授權(quán)日志6. 將使用關(guān)系數(shù)據(jù)同步到產(chǎn)品中心的cache中7. 通知產(chǎn)品端，服務(wù)授權(quán)成功8. 通知計(jì)費(fèi)中心授權(quán)用戶數(shù)1.5退訂服務(wù)調(diào)用形式：Hessian提供方： 產(chǎn)品中心調(diào)用方： 訂單系統(tǒng)接口名稱：退訂服務(wù)接口：com.alibaba.bss.pc2.server.remoting.IAuthorizeControllerServ

21、ice方法：public HashMap refundService(ArrayList paramMapList);接口描述：用戶在產(chǎn)品端自助退訂付費(fèi)產(chǎn)品服務(wù)，訂單系統(tǒng)會(huì)通知產(chǎn)品控制中心，產(chǎn)品控制中心刪除服務(wù)授權(quán)接口時(shí)序圖：接口參數(shù)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空List<refundPerParam>refundPerParamListList接口所需參數(shù)實(shí)體列表NrefundPerParam對象解析：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString在虛擬帳號IDN產(chǎn)品編號productCodeString需要暫停的產(chǎn)品編號N來源sou

22、rceString值域枚舉1：（訂單系統(tǒng)）N業(yè)務(wù)IDbusinessIdString訂單行號Y備注commentsString其它說明Y退訂時(shí)間gmtAuthorizeDate訂單系統(tǒng)的退訂時(shí)間Y接口返回對象：名稱類型說明resultboolean成功:true失敗:falseerrorCodeString錯(cuò)誤代碼11000 : 成功11001：服務(wù)授權(quán)不存在11002: 服務(wù)授權(quán)已過期12001 : refundPerParamList參數(shù)錯(cuò)誤12002 : vaccountId參數(shù)錯(cuò)誤12003 : 產(chǎn)品編號參數(shù)錯(cuò)誤12004 : 來源參數(shù)錯(cuò)誤12005 : 業(yè)務(wù)ID參數(shù)錯(cuò)誤12006 :

23、 備注參數(shù)錯(cuò)誤19001 : 系統(tǒng)異常errorInfoString錯(cuò)誤詳細(xì)信息接口調(diào)用流程說明:1. 當(dāng)訂單系統(tǒng)調(diào)用此接口退訂服務(wù)時(shí)通過vaccountId和產(chǎn)品編號取得服務(wù)授權(quán)記錄2. 若服務(wù)授權(quán)不存在，會(huì)有提示，但不報(bào)錯(cuò)3. 刪除service_id服務(wù)授權(quán)記錄4. 刪除service_id下所有的使用關(guān)系記錄5. 記錄授權(quán)日志6. 將使用關(guān)系數(shù)據(jù)同步到產(chǎn)品中心的cache中2. PC2依賴的外部接口2.1計(jì)費(fèi)中心需要產(chǎn)品端提供一個(gè)接口：通知授權(quán)用戶數(shù)2.2.1通知授權(quán)用戶數(shù)具體參數(shù)(List<Object>類型)：參數(shù)名稱變量名參數(shù)類型參數(shù)說明可空vaccountIdvaccountIdString虛擬帳號IDN產(chǎn)品編號productCodeString通知計(jì)費(fèi)的產(chǎn)品編號N授權(quán)用戶數(shù)currentNumString服務(wù)授權(quán)記