無標(biāo)題文章

[TOC]

1. 需求概要
2. 設(shè)計
3. 基本參數(shù)說明
4. 接口

后端中間件與游戲的設(shè)計分析

維護(hù)人	版本號	描述	日期
張紀(jì)	0.1	初版	2016-04-06
張紀(jì)	0.2	增加4.38接口	2016-04-08

1. 需求概要

后端中間件需要同各游戲之間做交互竖共，需要獲取游戲的數(shù)據(jù)，游戲中用戶的數(shù)據(jù)戚丸，以及對游戲中用戶數(shù)據(jù)做操作。中間件向游戲方發(fā)出請求后，在一定時間內(nèi)游戲方處理完后根據(jù)該份設(shè)計文檔定義的格式將結(jié)果返回給后端中間件。

需求中有需要客戶端做實現(xiàn)的會特別注明勉抓，如果游戲方的客戶端有實現(xiàn)的可忽略實現(xiàn)，但具體的實現(xiàn)要求需要游戲方同運營人員做詳細(xì)溝通
針對以上需求概要做了細(xì)分候学，現(xiàn)整理如下：

1.1 獲取游戲的所有服信息

游戲會存在單服或多服藕筋，這里中間件后續(xù)的各種請求都會基于游戲服去做對應(yīng)處理。

1.2 玩家個人資料獲取以及更新

獲取用戶在游戲里的一些基礎(chǔ)數(shù)據(jù),涉及到的ID方面的信息(平臺ID梳码，炫蹤UID隐圾，游戲UID)不允許被修改,其他均可修改，可修改的信息包括：真實姓名掰茶，性別暇藏，國籍，生日濒蒋，職業(yè)盐碱，郵箱，電話，其它聯(lián)系方式等等瓮顽，這部分信息應(yīng)該是在每個游戲里都存在县好，如果不存在的，游戲方可傳空或不傳趣倾。
玩家查詢條件為：具體游戲服里的游戲UID或者用戶在游戲里的昵稱或姓名聘惦。

1.3 玩家基礎(chǔ)游戲數(shù)據(jù)

玩家游戲數(shù)據(jù)包括玩家身份數(shù)據(jù)，狀態(tài)儒恋，實力善绎，經(jīng)濟(jì)數(shù)據(jù)，玩家游戲進(jìn)度诫尽，活躍度信息禀酱。

1.3.1 身份數(shù)據(jù)

玩家游戲UID
角色I(xiàn)D，角色名稱
所屬陣營/國家
所屬公會

1.3.2 玩家狀態(tài)

包括玩家當(dāng)前是否在線牧嫉，是否禁言剂跟，是否凍結(jié)（永久或臨時）

1.3.3 玩家實力

經(jīng)驗值
當(dāng)前等級
VIP積分
VIP等級

1.3.4 經(jīng)濟(jì)數(shù)據(jù)

經(jīng)濟(jì)數(shù)據(jù)主要包括以下數(shù)據(jù)，但依據(jù)各游戲類別不同酣藻，可能有的數(shù)據(jù)在某類游戲里有有的游戲里沒有曹洽，沒有的可不對數(shù)據(jù)做實現(xiàn)，另外后續(xù)也可能會增加一些接口辽剧，也是同樣規(guī)則送淆，沒有的可不做實現(xiàn)。

建筑數(shù)據(jù)
店鋪數(shù)據(jù)
資產(chǎn)數(shù)據(jù)
英雄數(shù)據(jù)
地塊數(shù)據(jù)
裝備數(shù)據(jù)
店員數(shù)據(jù)
技能數(shù)據(jù)
AVATAR數(shù)據(jù)
寶石數(shù)據(jù)
裝飾物數(shù)據(jù)
皮膚數(shù)據(jù)
社交數(shù)據(jù)
士兵數(shù)據(jù)
寵物數(shù)據(jù)

1.3.5 游戲進(jìn)度

以游戲為單位獲取用戶在游戲的不同的進(jìn)度怕轿，具體在接口中描述偷崩。

1.3.6 活躍度信息

包括最近14天活躍天數(shù)，最后登陸時間撞羽，最后充值時間等阐斜。(后續(xù)還有這里會再加上)

1.4 教學(xué)（新手）引導(dǎo)

需要先獲取游戲里所有的引導(dǎo)清單，然后針對用戶的某個或某批引導(dǎo)的完成情況做重置和跳過操作诀紊。

1.5 任務(wù)處理

需要先獲取游戲里所有的任務(wù)清單谒出，然后針對用戶的某個或某些任務(wù)做處理，會包括任務(wù)進(jìn)度修改邻奠，任務(wù)解鎖到推，重置任務(wù)。

1.6 成就處理

需要先獲取游戲里所有的成就清單惕澎，然后針對用戶的某個或某些成就做處理莉测，包括成就完成，成就的重置唧喉。

1.7 背包數(shù)據(jù)

獲取玩家游戲里背包里的數(shù)據(jù)捣卤，可對背包數(shù)據(jù)進(jìn)行實時修改和刪除操作忍抽，也能增加背包的數(shù)據(jù)。不同類別的游戲中董朝，背包里有的數(shù)據(jù)會存在屬性項目鸠项，可對屬性進(jìn)行修改，比如裝備，寶石等。

1.8 充值訂單記錄

獲取玩家在游戲里的充值記錄址芯，可按時間段查詢，訂單只做查看操作牧抽，不進(jìn)行任何其他更新操作。

1.9 活動設(shè)置

游戲上線前遥赚，需要預(yù)先將運營要設(shè)置的活動包放到游戲中扬舒，后續(xù)運營平臺通過向中間件發(fā)起活動的設(shè)置請求，設(shè)置主要集中在活動是否開啟凫佛，活動的起訖時間讲坎，強(qiáng)制關(guān)閉，游戲方需要判斷設(shè)置的活動是必須存在于游戲里愧薛。（客戶端實現(xiàn)）

1.10 賬號操作

需要對游戲里用戶賬號進(jìn)行一些封號（永久和臨時）晨炕，賬號數(shù)據(jù)重置，禁止（解禁）發(fā)言

1.11 補(bǔ)償操作

游戲中會經(jīng)常需要對用戶進(jìn)行各種補(bǔ)償毫炉，補(bǔ)償主要包括資源性補(bǔ)償瓮栗，背包里的物品補(bǔ)償。補(bǔ)償?shù)姆绞椒譃閮煞N：實時補(bǔ)償以及郵件補(bǔ)償（客戶端實現(xiàn)）

實時補(bǔ)償碘箍，游戲方需要接受補(bǔ)償?shù)臄?shù)據(jù)遵馆，待用戶在游戲里觸發(fā)后進(jìn)行實時補(bǔ)償操作鲸郊。
郵件補(bǔ)償丰榴，這里會設(shè)計2份數(shù)據(jù)保存，一個是郵件發(fā)送的數(shù)據(jù)秆撮，另外一個是實時補(bǔ)償?shù)臄?shù)據(jù)四濒，郵件補(bǔ)償也是需要用戶在游戲的郵件系統(tǒng)里操作后進(jìn)行實時補(bǔ)償操作。

1.12 登陸公告管理

中間件會想游戲發(fā)送登錄公告职辨，該公告只在用戶登錄游戲時彈出盗蟆，會帶有一些條件，滿足條件的才進(jìn)行彈出舒裤。（客戶端實現(xiàn)）

1.13 內(nèi)部郵件

即游戲中的郵件系統(tǒng)喳资，可以理解為向用戶發(fā)送內(nèi)容，中間件會向游戲?qū)懭豚]件內(nèi)容并由客戶端做展現(xiàn)腾供。（客戶端實現(xiàn)）

1.14 手機(jī)消息推送

該推送類似于在用戶關(guān)閉游戲或長期未打開游戲時推送的類似短信的內(nèi)容仆邓，中間件會請求游戲的寫入接口鲜滩，游戲收到手機(jī)推送消息后保存并有客戶端取的后端數(shù)據(jù)后根據(jù)一定邏輯做展現(xiàn)。（客戶端實現(xiàn)）

1.15 廣播處理

廣播是游戲在運行時在游戲內(nèi)顯示节值，可能有的是走馬燈徙硅，大喇叭，用戶系統(tǒng)通知等搞疗。中間件將廣播的數(shù)據(jù)通過接口寫入游戲嗓蘑，由客戶端展現(xiàn)。（客戶端實現(xiàn)）

1.16 排行榜查詢

通常的排行查詢匿乃，根據(jù)選擇的排行類型顯示排行列表桩皿，列表中可查看具體玩家信息

1.17 公會查詢

查詢游戲的公會信息，然后點詳情后可查看公會的用戶列表

1.18 調(diào)查問卷

這里會復(fù)雜些扳埂，中間件將問卷信息傳遞給游戲后端保存业簿，客戶端根據(jù)問卷設(shè)置做一定展現(xiàn)后，由用戶填寫阳懂，問卷完畢后梅尤，游戲后端需要保存調(diào)查數(shù)據(jù)然后中間件會通過接口獲取調(diào)查結(jié)果。 （客戶端實現(xiàn)）

1.19 loading界面管理

游戲加載畫面岩调，可加載的游戲畫面必須要事先已在游戲包中巷燥，然后有中間件來去請求接口保存loading界面的設(shè)置，客戶端根據(jù)設(shè)置來顯示loading界面号枕。（客戶端實現(xiàn)）

2. 設(shè)計

2.1 各游戲請求地址配置

游戲方接入時需要提供gameId和areaId以及與之對應(yīng)的請求的地址信息(不包含中間件請求的uri)缰揪，這里gameId為游戲id，areaId為游戲所在服id葱淳。
后端中間件會和不同游戲做交互钝腺，所以中間件請求的URI會在不同游戲中保持一致，后面會對請求的URI做說明赞厕。
如下：

字段名	類型	備注
gameId	int	游戲的唯一標(biāo)識
areaId	int	游戲服id
urlDomain	string	請求的地址信息(不包含中間件請求的uri)艳狐，http://game1_url，游戲方給出

2.2 請求方式以及入?yún)⒏袷蕉x

2.2.1 請求方式

以GET方式請求

2.2.2 入?yún)⒄f明

這里我們統(tǒng)一用新框架的*參數(shù)皿桑，參數(shù)入口為*毫目，格式為json字符串，原始格式如下：

array(
    "{$function}.{$action}",
    $params => array(...)
)

$params 的順序參看下面各接口的入?yún)⒄f明
這里json字符串需要進(jìn)行壓縮和base64操作诲侮，函數(shù)如下：

function compress($data, $needBase64Encode = false)
{
    $data = gzcompress(trim($data));

    if ($needBase64Encode) {
        $data = base64_encode($data);
    }

    return $data;
}

統(tǒng)一進(jìn)行base64編碼

示例：
原json字符串：[["Middleware.handleItem",[12,123,[{"itemDefId": 30005, "count": 1}],1441837585]]]
壓縮并base64: eJyLjlbyzUxJyUktTyxK1ctIzAMyPUtSc5V0og2NdAyNjHWiq5UygQIuqWmeKUpWCsYGBgamOgpKyfmleSVAvmFtrI6hiYmhhbG5qYVpbGwsADc6GEA=

2.3 請求的合法性校驗

參見“運營后臺中間件分析設(shè)計” 2.3 中的說明

2.4 返回結(jié)果說明

結(jié)果為json格式镀虐，如下說明

字段名	類型	備注
code	int	0為成功，大于0的標(biāo)示錯誤沟绪，具體錯誤見下面的msg說明
msg	mixed	返回數(shù)據(jù)的封裝,如果是錯誤刮便，這里將是一段描述說明

再向請求方發(fā)送數(shù)據(jù)前需要進(jìn)行壓縮并base64，函數(shù)參見2.3.2中的對應(yīng)說明绽慈。

3. 基本參數(shù)說明

3.1 gameId

gameId 是公司游戲針對不同平臺的不同語言產(chǎn)生的一個游戲的唯一標(biāo)識恨旱，這里不是單指某個游戲抄肖，比如花店這個游戲，它的英文版本以及該版本在facebook上的就會是一個gameId窖杀，如果這個英文版在其他平臺漓摩，如：ArmorGames，又會是另一個gameId入客，通彻鼙校可以理解為app id。

3.2 areaId

areaId 這里是針對gameId來的游戲服id桌硫，一個gameId會對應(yīng)多個areaId夭咬，即游戲多服的概念。

3.3 requestTime

請求接口的時間铆隘，對校驗會有一定的幫助卓舵，后段中間件默認(rèn)會在最后加上此參數(shù)。

4. 接口

4.1 獲取游戲所有服信息

接口名：Middleware.fetchGameSeverInfo
說明：獲取游戲所有服信息膀钠。
入?yún)⒄f明：

字段名	類型	備注
gameId	int	如前

{
    "data"：  
    [  
         {"serverName"： "華東一服","areaId"： 1,"url":"http://dev-flowershop2.shinezone.com/?pf_token=52d0ee3c031dd&token=52d0e112031dd&user_id=1"},
        {"serverName"： "華東二服","areaId"： 2,"url":"https://fs-join-facebook.shinezone.com/middleware.php?"}
    ]掏湾，  
    "message"： "success",  
    "status"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
serverName| string | 華東一服 | 游戲服名
areaId| int | 1 | 游戲服id
url | string |https://fs-join-facebook.shinezone.com/middleware.php? | 請求的url

4.2 搜索用戶

接口名：Middleware.searchUserList
說明：模糊搜索游戲中的用戶。
入?yún)⒄f明：

字段名	類型	備注
searchkey	string	查詢的關(guān)鍵字肿嘲，可以是玩家游戲里的uid融击，玩家炫蹤UID，游戲中的用戶名雳窟，游戲中使用的姓名(如果有)

{
    "msg"：  
    [  
        {
             "areaId"： 1,                  
            "uid":    868790,                          
            "nickname":    "tiger",                     
            "level":    32,                         
        },
        ....
        
    ]尊浪，  
    "code"： 0,  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
areaId| int | 1 | 游戲服id
uid| int | 868790 | 用戶游戲里的uid
nickname| string | tiger | 用戶昵稱
level| int | 32 | 用戶等級

4.3 游戲用戶信息

接口名：Middleware.fetchUserInfo
說明：以用戶的游戲uid獲取游戲中用戶的基本信息。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID

{
    "msg"：  
    {  
        "areaId"： 56485005488,                  
         "pfId"： 56485005488,                    
        "szUid"： 100001770390950,               
        "uid":    868790,                          
        "name":    "張紀(jì)",                          
        "level": 32,                            
        "sex":    "男",                            
        "nation":  "中國",                       
        ....                    
        
    }封救，  
    "code"： 0,  
}

返回msg字典說明：

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
areaId| int | 56485005488 | 游戲服ID
pfId| int | 56485005488 | 玩家平臺UID
szUid| int | 100001770390950 | 玩家炫蹤UID
uid| int | 868790 | 玩家游戲UID
name| string | 張紀(jì) | 真實姓名
level| int | 32 | 等級
sex| string | 男 | 性別
nation| string | 中國 | 國籍
birth| string | 1980-01-31 | 出生
job| string | 工程師 | 職業(yè)
email| string | zhangji@shinezone.com | 郵箱
tel| int | 8888888888888 | 電話
otherTel| int | 66666666666 | 其他聯(lián)系方式
isVip| int | 0 | 是否vip組

4.4 更新用戶基本信息

接口名：Middleware.updateUserInfo
說明：更新游戲中用戶的信息拇涤。
入?yún)⒄f明：

字段名	類型	備注
uid	string	游戲里的UID
info	json	這里只以下列舉的字段進(jìn)行更新,非以下列舉的會被屏蔽，最后更新結(jié)果依賴游戲方現(xiàn)有的字段

info列舉：

    {  
        "name":    "張紀(jì)",                          
        "sex":    "男",                            
        "nation":  "中國",                       
        "birth": "1980-01-31",                   
        "job":  "工程師",                         
        "email":  "zhangji@shinezone.com",       
        "tel":  "8888888888888",                  
        "otherTel":  "66666666666",              
    }

{
    "msg"： "更新成功"誉结，   
    "code"： 0  
}

4.5 獲取玩家游戲基礎(chǔ)數(shù)據(jù)

接口名：Middleware.fetchUserGameInfo
說明：獲取用戶在游戲基礎(chǔ)數(shù)據(jù)鹅士，具體參見下面返回的說明。
入?yún)⒄f明：

字段名	類型	備注
uid	string	游戲里的UID

{
    "msg"：  
    {  
         "areaId"： 56485005488,                  
        "szUid"： 100001770390950,               
        "uid":    868790,                          
        "roleID":    23,                          
        "roleName":    "上邪",                       
        ...
        
    }搓彻，   
    "code"： 0  
}

返回msg字典說明：

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
gameID| int | 1 | 游戲ID
areaId| int | 56485005488 | 游戲服ID
szUid| int | 100001770390950 | 玩家炫蹤UID
uid| int | 1234323 | 玩家游戲UID
roleID| int | 23 | 角色I(xiàn)D
roleName| string | 上邪 | 角色名
belong| string | 中國 | 所屬陣營/國家
belongGuild| string | 男神公會 | 所屬公會
exp| int | 1305 | 經(jīng)驗值
level| int | 24 | 等級
vipLev| int | 0 | Vip等級
vipExp| int | 0 | Vip積分
rank| int | 100 | 游戲排名
economy | json | [{"戰(zhàn)斗力",101,200},{"付費鉆石",201,6},....] | 玩家經(jīng)濟(jì)如绸，依據(jù)各游戲不同返回嘱朽，所以這里的數(shù)據(jù)里會帶有經(jīng)濟(jì)對應(yīng)的名稱和數(shù)量信息旭贬，第一項經(jīng)濟(jì)名稱，第二項是游戲里該經(jīng)濟(jì)存儲的id值搪泳，更新時會傳遞該值稀轨，第三項是具體的值
energy | json | [{"水",102,200}....] | 體力描述，第一項名稱岸军，第二項是游戲里的體力id奋刽，第三項是具體的值
baseSource | json | [{"糧食",103,300}....] | 基礎(chǔ)資源描述瓦侮，第一項名稱，第二項是游戲里的資源id佣谐，第三項是具體的值
corpProps | json | [{"圣劍",104,400}....] | 核心道具描述肚吏，第一項名稱，第二項是游戲里的核心道具id狭魂，第三項是具體的值
process | json | [{"成就進(jìn)度",15/200}....] | 玩家進(jìn)度描述罚攀，第一項進(jìn)度名稱，第二項是進(jìn)度具體的值
lastLoginTime | int | 1458662400 | 最后登錄時間雌澄，時間戳
lastRechargeTime | int | 1458662400 | 最后充值時間斋泄，時間戳
activeDayFor14 | int | 5 | 最近14天活躍天數(shù)
isOnline | int | 0 | 0=不在線，1=在線
silenceTime | int | 0 | 0=不禁言镐牺，>0代表禁言的到期時間,時間戳炫掐，如：1458748800，代表2016-03-24零點解禁
forbiddenTime | int | 0 | 0=不凍結(jié)睬涧，>0代表凍結(jié)的到期時間,時間戳募胃，如：1458748800，代表2016-03-24零點解凍

4.6 更新玩家游戲基礎(chǔ)數(shù)據(jù)

接口名：Middleware.updateUserGameInfo
說明：更新用戶在游戲基礎(chǔ)數(shù)據(jù)畦浓，具體參見下面返回的說明摔认。
入?yún)⒄f明：

字段名	類型	備注
areaId	string	游戲服ID
uid	json	游戲里的UID, ex:[1,2,3,4....]
info	json	這里只以下列舉的字段進(jìn)行更新,非以下列舉的會被屏蔽，最后更新結(jié)果依賴游戲方現(xiàn)有的字段

info字典說明：

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
exp| int | 1305 | 經(jīng)驗值
level| int | 24 | 等級
vipLev| int | 0 | Vip等級
vipExp| int | 0 | Vip積分
rank| int | 100 | 游戲排名
economy | json | [{101,200},{201,6},....] | 玩家經(jīng)濟(jì)宅粥，第一項是游戲里該經(jīng)濟(jì)存儲的id值参袱，第二項是具體的值
energy | json | [{102,200}....] | 體力描述，第一項是游戲里的體力id秽梅，第二項是具體的值
baseSource | json | [{103,300}....] | 基礎(chǔ)資源描述抹蚀，第一項是游戲里的資源id，第二項是具體的值
corpProps | json | [{104,400}....] | 核心道具描述企垦，第一項是游戲里的核心道具id环壤，第二項是具體的值
silenceTime | int | 0 | 0=不禁言，>0代表禁言的到期時間,時間戳钞诡，如：1458748800郑现，代表2016-03-24零點解禁
forbiddenTime | int | 0 | 0=不凍結(jié)，>0代表凍結(jié)的到期時間,時間戳荧降，如：1458748800接箫，代表2016-03-24零點解凍

{  
    "msg"： "success",  
    "code"： 0  
}

4.7 重置玩家所有游戲數(shù)據(jù)

接口名：Middleware.resetUserGameData
說明：重置玩家所有游戲數(shù)據(jù)，具體參見下面返回的說明朵诫。
入?yún)⒄f明：

字段名	類型	備注
uid	json	游戲里的UID,ex[1,2,3,4]

{
    "msg"： 
    {
        "status": 1,//重置是否成功1=成功辛友，0=未成功
        "uid": 100010200112
    }，   
    "code"： 0  
}

4.8 獲取游戲所有教學(xué)引導(dǎo)清單

接口名：Middleware.fetchGuideList
說明：獲取游戲里所有的教學(xué)引導(dǎo)列表剪返。
入?yún)⒄f明：

字段名	類型	備注
areaId	int	游戲服ID
gameId	int	游戲UID

{
    "msg"：  
    [  
         {"defId"： 1,"desrc":"教你升級","unlockDesc":"解鎖商城后的首次點擊","totalSteps":5,"expectLev":3},
        ...
    ]废累，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 引導(dǎo)定義的id邓梅，再給玩家操作引導(dǎo)的時候會傳遞
desrc| string | 教你升級 | 描述
unlockDesc| string | 解鎖商城后的首次點擊 | 解鎖的描述
totalSteps| int | 5 | 該步引導(dǎo)的步數(shù)
expectLev| int | 3 | 該引導(dǎo)要達(dá)到的等級

4.9 獲取用戶在游戲中引導(dǎo)的狀態(tài)

接口名：Middleware.fetchUserGuideList
說明：獲取用戶在游戲中的引導(dǎo)狀態(tài)。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID

{
    "msg"：  
    [  
         {"defId"： 1,"status":0},
        ...
    ]邑滨，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 引導(dǎo)定義的id日缨，再給玩家操作引導(dǎo)的時候會傳遞
status| int | 0 | 0=未解鎖,1=未通過,2=已通過

4.10 更新用戶在游戲中引導(dǎo)的狀態(tài)

接口名：Middleware.updateUserGuideList
說明：更新用戶在游戲中的引導(dǎo)狀態(tài)，對單個用戶的可進(jìn)行批量狀態(tài)更新掖看。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID
defId	string	引導(dǎo)的定義ID殿遂，{1,2....}
status	int	要修改的狀態(tài)

{
    "msg"：  
    [  
         {"defId"： 1,"status":1},
        ...
    ]，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 引導(dǎo)定義的id
status| int | 0 | 0=未解鎖乙各，1=未通過墨礁，2=已通過，-1=修改失敗

4.11 獲取游戲所有任務(wù)清單

接口名：Middleware.fetchTaskList
說明：獲取游戲里所有的任務(wù)列表耳峦。
入?yún)⒄f明：

字段名	類型	備注
areaId	int	游戲服ID
gameId	int	游戲UID

{
    "msg"：  
    [  
         {"defId"： 1,"desrc":"教你升級","unlockDesc":"解鎖商城后的首次點擊","type":"行為類任務(wù)","expectLev":3},
        ...
    ]恩静，   
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 任務(wù)定義的id，再給玩家操作任務(wù)的時候會傳遞
desrc| string | 教你升級 | 描述
unlockDesc| string | 解鎖商城后的首次點擊 | 解鎖的描述
type| string | 行為類任務(wù) | 任務(wù)類型
expectLev| int | 3 | 該任務(wù)要達(dá)到的等級

4.12 獲取用戶在游戲中任務(wù)清單

接口名：Middleware.fetchUserTaskList
說明：獲取用戶在游戲中的任務(wù)數(shù)據(jù)蹲坷。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID

{
    "msg"：  
    [  
         {"id":100, "defId"： 1,"status":0},
        ...
    ]驶乾，   
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
id | int | 100 | 玩家游戲里任務(wù)存儲的id，再給玩家操作任務(wù)的時候會傳遞
defId| int | 1 | 任務(wù)定義的id
status| int | 0 | 0=未解鎖,1=未完成,2=已完成

4.13 更新用戶在游戲中任務(wù)的狀態(tài)

接口名：Middleware.updateUserTaskList
說明：更新用戶在游戲中的任務(wù)狀態(tài)循签，可進(jìn)行批量更新狀態(tài)级乐。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID
Id	int	存儲任務(wù)的ID，{1,2....}
status	int	要修改的狀態(tài) 0=未解鎖,1=未完成,2=已完成

{
    "msg"：  
    [  
         {"Id"： 1,"status":1},
        ...
    ]县匠，   
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 存儲任務(wù)的ID风科，當(dāng)為0的時候表示任務(wù)被更改為未解鎖
status| int | 0 | 0=未解鎖，1=未完成乞旦，2=已完成贼穆，-1=修改失敗

4.14 獲取游戲所有成就清單

接口名：Middleware.fetchAchieveList
說明：獲取游戲里所有的成就列表。
入?yún)⒄f明：

字段名	類型	備注
areaId	int	游戲服ID
gameId	int	游戲UID

{
    "msg"：  
    [  
         {"defId"： 1,"desrc":"教你升級","unlockDesc":"解鎖商城后的首次點擊","type":"行為類任務(wù)","expectLev":3,"title":"我的配置稱號"},
        ...
    ]兰粉，   
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 成就定義的id故痊，再給玩家操作成就的時候會傳遞
desrc| string | 教你升級 | 描述
unlockDesc| string | 解鎖商城后的首次點擊 | 出現(xiàn)條件的描述
type| string | 行為類任務(wù) | 成就類型
expectLev| int | 3 | 該成就要達(dá)到的等級
title| string | 配置稱號 | 配套稱號 TODO 不明白

4.15 獲取用戶在游戲中成就列表

接口名：Middleware.fetchUserAchieveList
說明：獲取用戶在游戲中的成就數(shù)據(jù)。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID

{
    "msg"：  
    [  
         {"defId"： 1,"status":0},
        ...
    ]玖姑，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 成就定義的id愕秫，再給玩家操作成就的時候會傳遞
status| int | 0 | 0=未解鎖,1=未完成,2=已完成

4.16 更新用戶在游戲中成就的狀態(tài)

接口名：Middleware.updateUserAchieveList
說明：更新用戶在游戲中的成就狀態(tài)，可進(jìn)行批量更新用戶的成就狀態(tài)焰络。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID
defId	string	成就的定義ID戴甩，{1,2....}
status	int	要修改的狀態(tài) 0=未解鎖，1=未完成舔琅，2=已完成等恐，

{
    "msg"：  
    [  
         {"defId"： 1,"status":1},
        ...
    ]洲劣，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 成就定義的id
status| int | 0 | 0=未解鎖备蚓，1=未完成课蔬，2=已完成，-1=修改失敗

4.18 獲取用戶在游戲中所有游戲數(shù)據(jù)列表

接口名：Middleware.fetchUserGameData
說明：獲取用戶在游戲中的游戲數(shù)據(jù)郊尝，會根據(jù)傳入的要獲取的類型二跋，然后每個數(shù)據(jù)類型會有一個對應(yīng)的json格式，具體會在后面進(jìn)行描述流昏，這里的數(shù)據(jù)是運營給出的扎即，如果游戲里有認(rèn)為不妥或不明白之處，請及時與我溝通况凉，這里如果接入的游戲有的沒有該游戲數(shù)據(jù)可不必實現(xiàn)
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID
dataType	string	要獲取的類型谚鄙，說明如下

dataType類型枚舉

字段名	值
Building	建筑
Assets	資產(chǎn)
Hero	英雄
Store	店鋪
Item	裝備
Skill	技能
Ground	地塊
Employee	店員
Avatar	AVATAR
Gem	寶石
Decorations	裝飾物
Sociality	社交
Soldier	士兵
Pet	寵物
Skin	皮膚

返回參考：

{
    "msg"：  
    [  
         {
            "Id"： 1
            ...
        },
        ...
    ]，  
    "code"： 0  
}

每種dataType類型返回data中字典說明如下：

Building=建筑的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id刁绒，再給玩家操作成就的時候會傳遞
unlockTime| int | 1458662400 | 解鎖時間
buyTime| int | 1458662400 | 購買時間
status| int | 0 | 0=倉庫中,1=外部閑置,2=使用中

Assets=資產(chǎn)的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id闷营，再給玩家操作的時會傳遞
name| string | 農(nóng)田 | 資產(chǎn)名稱
getTime| int | 1458662400 | 獲取時間
lev| int | 3 | 當(dāng)前等級
defId | int | 0 | 資產(chǎn)定義ID
status| int | 0 | 0=倉庫中,1=外部閑置,2=使用中

Hero=英雄的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id，再給玩家操作的時會傳遞
name| string | titan | 英雄名稱
exp| int | 200 | 英雄經(jīng)驗
lev| int | 3 | 英雄等級
quality| int | 3 | 英雄品質(zhì)
star| int | 3 | 英雄星級
getTime| int | 1458662400 | 獲得時間
profession| string | 術(shù)士 | 英雄職業(yè)
status| int | 0 | 0=閑置,1=陣型中,2=訓(xùn)練中知市，3=出戰(zhàn)中

Store=店鋪的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id傻盟，再給玩家操作的時會傳遞
name| string | titan | 店鋪名稱
unclockTime| int | 1458662400 | 解鎖時間
opTime| int | 1458662400 | 上次操作時間
opData | json | [{"lev":12},{"squar":5*5}] | 這里設(shè)置稍靈活些，是用json格式嫂丙，目前暫時有擴(kuò)張（squar）和升級（level）,后續(xù)可繼續(xù)擴(kuò)展

Item=裝備的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id娘赴，再給玩家操作的時會傳遞
name| string | titan | 裝備名稱
setting| json | [{"id":1000,"name":"寶石"},....] | 裝備鑲嵌的內(nèi)容 id為鑲嵌的存儲id，name為鑲嵌的中文名稱
lev| int | 3 | 裝備等級
quality| int | 3 | 裝備品質(zhì)
star| int | 3 | 裝備星級
getTime| int | 1458662400 | 獲得時間
profession| string | 獵人 | 裝備職業(yè)
status| string | 閑置 | 當(dāng)前裝備使用信息

Skill=技能的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id跟啤，再給玩家操作的時會傳遞
name| string | titan | 技能名稱
lev| int | 3 | 技能等級
hero| json | {"id":101,"name":"關(guān)公"} | 所屬英雄技能所屬英雄id诽表，和英雄名稱
status| string | 閑置、呂布（紫） | 當(dāng)前狀態(tài)

Ground=地塊的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id隅肥，再給玩家操作的時會傳遞
name| string | 風(fēng)水寶地 | 地塊名稱
status| int | 0 | 0=未解鎖关顷、1=已解鎖

Employee=店員的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id，再給玩家操作的時會傳遞
name| string | TIger | 店員名稱
status| int | 0 | 0=未解鎖武福、1=閑置议双、2=工作中

Avatar=AVATAR的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id，再給玩家操作的時會傳遞
part| string | 手 | AVATAR部位
lev | int | 2 | AVATAR等級
status| string | 閑置捉片、使用中（駐店歌手） | 當(dāng)前狀態(tài)

Gem=寶石的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id平痰，再給玩家操作的時會傳遞
name| string | 紫寶石 |寶石名稱
defId| int | 1000121 |寶石定義ID
lev | int | 1 | 寶石等級
useInfo| string | 屠龍刀（紫） | 具體使用情況

Decorations=裝飾物的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id，再給玩家操作的時會傳遞
name| string | 壁紙 |裝飾物名稱
defId| int | 1000121 |裝飾物定義ID
type | string | 室外裝飾 | 裝飾物類型
getTime | int | 1458662400 | 獲得時間
status | string | 倉庫中 | 當(dāng)前狀態(tài) 0=倉庫中,1=外部閑置,2=使用中

Skin=皮膚的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id伍纫，再給玩家操作的時會傳遞
name| string | 天空藍(lán) |皮膚名稱
lev | int | 1 | 皮膚等級
useInfo| string | 閑置宗雇、使用中（關(guān)羽） | 具體使用情況

Sociality=社交的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 游戲里存儲的id，再給玩家操作的時會傳遞
name| string | lucaus |好友名稱
lev| int | 1 |好友等級
getTime | int | 1458662400 | 加好友時間
val| int | 10 |友情值

Soldier=士兵的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 兵種ID莹规，再給玩家操作的時會傳遞
name| string | 攻擊兵 |兵種名稱
total| int | 1000 |擁有數(shù)量
useInfo| string | 閑置赔蒲、使用中（1000/5000） | 當(dāng)前使用情況

Pet=寵物的data字典

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
Id| int | 1 | 寵物ID，再給玩家操作的時會傳遞
name| string | titan | 寵物名稱
exp| json | 200 | 寵物經(jīng)驗
lev| int | 3 | 寵物等級
quality| int | 3 | 寵物品質(zhì)
star| int | 3 | 寵物星級
race| string | 大和 | 寵物種族
getTime| int | 1458662400 | 獲得時間
status| string | 閑置、陣型中舞虱、訓(xùn)練中欢际、出戰(zhàn)中 | 當(dāng)前使用信息

4.19 更新用戶在游戲中數(shù)據(jù)

接口名：Middleware.updateUserGameData
說明：更新用戶在游戲中的建筑物數(shù)據(jù)，依據(jù)updateData里的說明來矾兜。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID
dataType	string	數(shù)據(jù)類型损趋，參見上述接口中的說明
updateData	json	要修改的數(shù)據(jù)，會根據(jù)dataType不同而有不同的json數(shù)據(jù)格式

updateData各數(shù)據(jù)類型的json格式描述如下：

Building=建筑

字段名	類型	備注
Id	json	游戲存儲的ID椅寺，{1,2....}
status	int	要修改的狀態(tài) 0=倉庫中,1=外部閑置,2=使用中

Assets=資產(chǎn)

字段名	類型	備注
Id	json	游戲存儲的ID浑槽，{1,2....}
status	int	要修改的狀態(tài) 0=倉庫中,1=外部閑置,2=使用中
lev	int	要修改的等級

Hero=英雄

字段名	類型	備注
Id	json	游戲存儲的ID，{1,2....}
exp	int	英雄經(jīng)驗, 不修改返帕，請保持為空
lev	int	英雄等級,不修改桐玻，請保持為空
quality	int	英雄品質(zhì),不修改，請保持為空
star	int	英雄星級荆萤，不修改畸冲，請保持為空

Store=店鋪

字段名	類型	備注
Id	json	游戲存儲的ID，{1,2....}
unclock	int	解鎖的狀態(tài) 0=未解鎖,1=解鎖
opData	json	[{"lev":12},{"squar":5*5}]	這里設(shè)置稍靈活些观腊，目前暫時有擴(kuò)張和升級,后續(xù)可繼續(xù)擴(kuò)展邑闲，lev設(shè)置等級，squar設(shè)置面積

Item=裝備

字段名	類型	備注
Id	json	游戲存儲的ID梧油，{1,2....}
lev	int	裝備等級不修改苫耸，請保持為空
quality	int	裝備品質(zhì) 不修改，請保持為空
star	int	裝備星級不修改儡陨，請保持為空

Skill=技能

字段名	類型	備注
Id	json	游戲存儲的ID褪子，{1,2....}
lev	int	技能等級

Ground=地塊

字段名	類型	備注
Id	json	游戲存儲的ID，{1,2....}
status	int	要修改的狀態(tài) 0=未解鎖,1=解鎖

Employee=店員

字段名	類型	備注
Id	json	游戲存儲的ID骗村，{1,2....}
status	int	要修改的狀態(tài) 0=未解鎖,1=解鎖嫌褪，解鎖后等同于閑置

Avatar=AVATAR

字段名	類型	備注
Id	json	游戲存儲的ID，{1,2....}
status	int	要修改的狀態(tài) 0=未解鎖,1=解鎖胚股，解鎖后等同于閑置

Gem=寶石

字段名	類型	備注
Id	json	游戲存儲的ID笼痛，{1,2....}
lev	int	要修改的等級

Decorations=裝飾物

字段名	類型	備注
Id	json	游戲存儲的ID，{1,2....}
status	int	要修改的狀態(tài) 0=未解鎖,1=倉庫中,2=外部閑置,3=使用中

Skin=皮膚

字段名	類型	備注
Id	json	游戲存儲的ID琅拌，{1,2....}
lev	int	要修改的等級

Sociality=社交

字段名	類型	備注
Id	json	游戲存儲的ID缨伊，{1,2....}
val	int	要修改的友情值

Soldier=士兵

字段名	類型	備注
Id	json	游戲存儲的ID，{1,2....}
total	int	要修改的數(shù)量

Pet=寵物

字段名	類型	備注
Id	int	游戲存儲的ID进宝，{1,2....}
exp	int	要修改的寵物經(jīng)驗
lev	int	要修改的寵物等級
quality	int	寵物品質(zhì) 不修改刻坊，請保持為空
star	int	寵物星級不修改，請保持為空

{
    "msg"：  
    [  
         {
            "defId"： 1
            "status": 0
        },
        ...
    ]党晋，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 游戲存儲的ID
status| int | 0 | 0=修改失敗谭胚，1=修改成功

4.20 刪除用戶在游戲中數(shù)據(jù)

接口名：Middleware.deleteUserGameData
說明：刪除用戶在游戲中的建筑物徐块，可進(jìn)行批量。
入?yún)⒄f明：

字段名	類型	備注
uid	int	游戲里的UID
Id	string	游戲里存儲的ID灾而，{1,2....}

{
    "msg"：  
    [  
         {"defId"： 1,"status":1},
        ...
    ]胡控，  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 游戲存儲的ID
status| int | 0 | 0=刪除失敗,1=刪除成功

4.21 獲取用戶的充值記錄

接口名： Middleware.fetchUserPayList
說明：對外平臺獲取用戶在游戲里充值記錄，包含成功或不成功绰疤。
入?yún)⒄f明：如下：

字段名	類型	備注
uid	int	游戲里的UID
queryTime	int	當(dāng)前查詢的時間,標(biāo)準(zhǔn)的格林威治時間戳.
limit	int	最大查詢返回結(jié)果 ,默認(rèn)50

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0铜犬，
    "msg"：[
        {"orderId"：11122,"userId"：12,"gameId"：1,...}舞终，
        ...
    ]
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
orderId| int | 100001 | 訂單號
payTime| int | 1458662400 | 充值時間
uid| int | 1 | UID
money| int | 100| 充值金額
payText | json | [{"name":"鉆石","count":50},...] | 充值內(nèi)容 name=充值對象轻庆，count=充值數(shù)量
status| int | 0 | 是否付款 0=未付款，1=已付款

4.22 活動設(shè)置

接口名：Middleware.updateActivity
說明：更新游戲中的活動項敛劝，比如開啟動狀態(tài)余爆，開啟時間，持續(xù)天數(shù)等夸盟，當(dāng)活動不存在的時候會進(jìn)行插入蛾方，存在進(jìn)行更新。
入?yún)⒄f明：

字段名	類型	備注
defId	int	活動的定義ID
startTime	int	活動開啟時間
endTime	int	活動結(jié)束時間
awardSTime	int	活動領(lǐng)獎開始時間
awardETime	int	活動領(lǐng)獎結(jié)束時間
icon	string	活動icon,預(yù)留在客戶端內(nèi)
desrc	string	活動描述
tabOrder	int	活動在客戶端列表顯示的順序
tabName	string	活動的在客戶端顯示的標(biāo)簽名
linkText	string	活動按紐文字
loopDays	int	循環(huán)活動間隔天數(shù)上陕，為0表示不循環(huán)桩砰，為其他值表示循環(huán)。
status	init	活動狀態(tài) 0=未開啟释簿，1=進(jìn)行中亚隅，2=已結(jié)束，3=強(qiáng)制關(guān)閉

{
    "msg"：  
     {
        "defId"： 1,"status":1
    },  
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 1 | 引導(dǎo)定義的id
status| int | 0 | 1=更新成功庶溶，0=更新失敗

4.23 道具檢查

接口名： Middleware.checkItem
說明：提供給對外平臺檢查道具是否已經(jīng)配置在游戲中.
入?yún)⒄f明：

字段名	類型	備注
items	json	具體的道具內(nèi)容煮纵，[{ "itemDefId"：11111}，....]

返回：標(biāo)準(zhǔn)格式返回

{
    "code"： 0,
    "msg"： 
    [
        {"itemDefId"：11111,"status"：0},
        {"itemDefId"：22222,"status"：1}, 
        .....
    ]
}

status 會有2種狀態(tài)值偏螺，0 不存在 1 已存在

4.24 獲取用戶的所有道具

接口名： Middleware.fetchUserItems
說明：獲取用戶在游戲里的所有道具行疏。
入?yún)⒄f明：如下：

字段名	類型	備注
uid	int	游戲里的UID

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0，
    "msg"：[
        {"defId"：11122,"name：12,...}套像，
        ...
    ]
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
defId| int | 100001 | 道具定義id
name| int | 小卡片 | 道具名稱
count| int | 10 | 道具數(shù)量

4.25 道具派發(fā)

接口名： Middleware.deliverItem
說明：給用戶派發(fā)道具.
入?yún)⒄f明：

字段名	類型	備注
uid	json	游戲的uid,ex:[1,2,3,....]
deliverId	int	派發(fā)請求id酿联，游戲方要做保存
items	json	具體的道具內(nèi)容，[{ "itemDefId"：11111夺巩， " count"：123}货葬，....]

返回：標(biāo)準(zhǔn)格式返回

{
    "code"： 0,
    "msg"： 
    [
        {
        "deliverId"：121212,
        "deliverStatus"：0
        }
    ]
}

deliverStatus 會有3種狀態(tài)值，-1 派發(fā)失敗劲够，0 已提交 1 已派發(fā)

4.26 登錄公告設(shè)置

接口名：Middleware.updateLoginNotice
說明：設(shè)置游戲登錄強(qiáng)制彈出公告余舶。
入?yún)⒄f明：

字段名	類型	備注
noticeId	int	公告id,為0的時候表示新增加庇谆，為其他值表示更新對應(yīng)的公告設(shè)置
minLev	int	最低用戶等級
maxLev	int	最高用戶等級
isForce	int	是否強(qiáng)制彈出
title	string	公告標(biāo)題
content	string	公告內(nèi)容
startTime	int	彈出開始時間
endTime	string	彈出結(jié)束時間

{
    "msg"：  
     {
        "status":1
    }, 
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功，0=寫入失敗

4.27 手機(jī)消息推送設(shè)置

接口名：Middleware.updatePushNotice
說明：設(shè)置游戲手機(jī)推送，類似游戲中的通知信息，由游戲方實現(xiàn)展示內(nèi)容情萤。
入?yún)⒄f明：

字段名	類型	備注
pushId	int	消息id,為0的時候表示新增加，為其他值表示更新對應(yīng)的公告設(shè)置
minLev	int	最低用戶等級
maxLev	int	最高用戶等級
type	int	彈出類型, 1=每日回訪提醒, 2=流失召回提醒
nologinDay	int	當(dāng)類型為流失召回的時候需要填寫未登錄天數(shù)進(jìn)行配合推送
content	string	公告內(nèi)容
startTime	int	推送開始時間
endTime	int	推送結(jié)束時間
showTime	string	顯示時間推送消息的顯示時間，ex: 12:00

{
    "msg"：  
     {
        "status":1
    }, 
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功忙厌，0=寫入失敗

4.28 系統(tǒng)廣播設(shè)置

接口名：Middleware.updateSysNotice
說明：系統(tǒng)廣播設(shè)置，游戲打開時的展示江咳。
入?yún)⒄f明：

字段名	類型	備注
sysId	int	系統(tǒng)廣播id,為0的時候表示新增加逢净，為其他值表示更新對應(yīng)的設(shè)置
type	int	公告類型，游戲方需要預(yù)先定義
interval	int	間隔時間歼指，單位：秒,為0表示不間隔
content	string	廣播內(nèi)容
startTime	int	開始時間
endTime	int	結(jié)束時間

{
    "msg"：  
     {
        "status":1
    },
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功爹土，0=寫入失敗

4.29 loading界面管理

接口名：Middleware.updateLoadingPage
說明：更新loading界面信息，要更新的界面必須事先存在包中踩身。
入?yún)⒄f明：

字段名	類型	備注
loadingId	int	loading信息id,為0的時候表示新增加胀茵，為其他值表示更新對應(yīng)的設(shè)置
imageDefId	int	圖片id，預(yù)先在客戶端包內(nèi)
status	int	0=閑置挟阻，1=使用琼娘，當(dāng)使用時，會將前面使用的圖片置為0

{
    "msg"：  
     {
        "status":1
    },
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功附鸽，0=寫入失敗

4.30 獲取排行榜查詢

接口名： Middleware.fetchRankingList
說明：獲取游戲服里有關(guān)數(shù)據(jù)后脱拼，根據(jù)選擇的進(jìn)行排序。
入?yún)⒄f明：如下：

字段名	類型	備注
limit	int	要顯示的條數(shù)坷备，大于1000熄浓，不被接受

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0，
    "msg"：[
        {"uid"：11122,"uname"："青龍",...}击你，
        ...
    ]
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
uid| int | 1000 | 用戶id號玉组，查看用戶詳情時需要傳入
uname| string | 青龍 | 用戶角色名
lev| int | 8 | 角色等級
fighting| int | 1000 | 戰(zhàn)斗力
guild|string | 大公會 | 所屬公會
totalPay | int | 1000 | 累計充值額
lastLoginTime | int | 1458662400 | 最后登錄時間

4.31 公會查詢

接口名： Middleware.fetchGuildList
說明：獲取游戲服的公會信息。
入?yún)⒄f明：如下：

字段名	類型	備注
keyword	string	公會關(guān)鍵字

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0丁侄，
    "msg"：[
        {"guildId",1000,"areaName"："英雄傳說","name"："大公會"...}惯雳，
        ...
    ]
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
guildId| int | 1000 | 公會id號，查看詳情時需要傳入
areaName| string | 英雄傳說 | 游戲服名稱
uid| int | 1 | 游戲創(chuàng)建人UID
uname| string | 青龍 | 游戲創(chuàng)建人角色名
lev| int | 8 | 公會等級
createTime|int | 1458662400 | 創(chuàng)建時間

4.32 公會詳情查詢

接口名： Middleware.fetchGuildDetail
說明：獲取游戲服的公會詳細(xì)信息鸿摇，主要是公會里的一些用戶角色信息石景。
入?yún)⒄f明：如下：

字段名	類型	備注
guildId	int	公會id號

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0，
    "msg"：[
        {"uid",1000,"uname"："青龍",...}拙吉，
        ...
    ]
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
uid| int | 1000 | 用戶id號潮孽，查看用戶詳情時需要傳入
uname| string | 青龍 | 用戶角色名
lev| int | 8 | 角色等級
fighting| int | 1000 | 戰(zhàn)斗力
captain|string | 成員，長老等 | 公會頭銜

4.33 內(nèi)部郵件發(fā)送

接口名：Middleware.updatePushMail
說明：發(fā)送內(nèi)部郵件筷黔，但帶有獎勵字段的時候往史，客戶端獲取信息后需要有一定效果展現(xiàn)。
入?yún)⒄f明：

字段名	類型	備注
mailId	int	郵件id,為0的時候表示新增加佛舱，為其他值表示更新對應(yīng)的公告設(shè)置
minLev	int	最低用戶等級
maxLev	int	最高用戶等級
title	string	標(biāo)題
content	string	內(nèi)容
sendTime	int	發(fā)送時間
award	json	獎勵json格式 [{"defId":1210011,"count":1},...]椎例，為空時表示不獎勵挨决。

{
    "msg"：  
     {
        "status":1
    },
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功，0=寫入失敗

4.34 實時補(bǔ)償

接口名：Middleware.appendUserGameData
說明：實時補(bǔ)償操作订歪。
入?yún)⒄f明：

字段名	類型	備注
uid	json	要發(fā)放用戶的uid脖祈，ex [1,2,3,4]，不填寫的時候表示所選游戲服的所有用戶
lev	int	控制可看到該補(bǔ)償玩家等級
award	json	元寶刷晋，金幣之類的獎勵字段盖高，依據(jù)游戲不同，這里運營平臺做配置傳入 [{"field":token,"count":1},{"field":gem,"count":5},...]
item	json	獎勵json格式 [{"defId":1210011,"count":1},...]
startTime	int	補(bǔ)償按鈕icon出現(xiàn)時間
endTime	int	補(bǔ)償按鈕icon消失時間

{
    "msg"：  
     {
        "status":1
    }, 
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功眼虱，0=寫入失敗

4.35 郵件補(bǔ)償

接口名：Middleware.appendUserGameDataByEmail
說明：郵件補(bǔ)償操作喻奥，需要客戶端設(shè)置相應(yīng)的郵件規(guī)則，比如點了后要能進(jìn)行補(bǔ)償發(fā)放蒙幻。
入?yún)⒄f明：

字段名	類型	備注
uid	json	要發(fā)放用戶的uid映凳，ex [1,2,3,4],不填寫的時候表示所選游戲服的所有用戶
lev	int	控制可看到該補(bǔ)償玩家等級
award	json	元寶胆筒，金幣之類的獎勵字段邮破，依據(jù)游戲不同，這里運營平臺做配置傳入 [{"field":token,"count":1},{"field":gem,"count":5},...]
item	json	獎勵json格式 [{"defId":1210011,"count":1},...]
startTime	int	出現(xiàn)時間
endTime	int	消失時間

{
    "msg"：  
     {
        "status":1
    }, 
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功仆救，0=寫入失敗

4.36 調(diào)查問卷管理/游戲答題

接口名：Middleware.updateSurveyOrQuestion
說明：發(fā)送內(nèi)部郵件抒和，但帶有獎勵字段的時候，客戶端獲取信息后需要有一定效果展現(xiàn)彤蔽。
入?yún)⒄f明：

字段名	類型	備注
surveyId	int	問卷id,為0的時候表示新增加摧莽，為其他值表示更新對應(yīng)的公告設(shè)置，游戲方需要保存此id顿痪，便于后面取調(diào)查結(jié)果
minLev	int	最低用戶等級
maxLev	int	最高用戶等級
startTime	int	問卷開始時間
endTime	int	問卷結(jié)束時間
title	string	調(diào)查標(biāo)題
content	string	調(diào)查說明
items	json	調(diào)查內(nèi)容項镊辕，json格式,具體說明見后面描述
award	json	元寶，金幣之類的獎勵字段蚁袭，依據(jù)游戲不同征懈，這里運營平臺做配置傳入 ex: [{"field":token,"count":1},{"field":gem,"count":5},...]
awardItem	json	獎勵道具之類，填寫defid和數(shù)量揩悄，json格式 ex: [{"defId":1210011,"count":1},...]
awardCondition	int	領(lǐng)獎條件 1=答完領(lǐng)取 2=答對才領(lǐng)取

items 調(diào)查內(nèi)容項返回參考：

    [  
         {
            "order"： 1
            ...
        },
        ...
    ]卖哎，

items具體字典說明如下：

字段名 | 類型 | 備注 | 樣列
--- | --- | ---
questionId| int | 問題號 | 1
title| string | 問題 | 你從哪得知我們的游戲
options| json | 調(diào)查選項目 | [{"option":1,"content":"從網(wǎng)絡(luò)上下載"，"isRight":1},.....] option=選項序號删性，content=調(diào)查具體項亏娜，isRight=是否正確答案，0=不是蹬挺，1是

接口返回：

{
    "msg"：  
     {
        "status":1
    },
    "code"： 0  
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
status| int | 0 | 1=接收成功维贺，0=寫入失敗

4.37 獲取問卷調(diào)查結(jié)果

接口名： Middleware.fetchSurveyList
說明：獲取用戶的調(diào)查問卷結(jié)果。
入?yún)⒄f明：如下：

字段名	類型	備注
surveyId	int	問卷id
startTime	int	查詢開始時間
endTime	int	查詢結(jié)束時間

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0巴帮，
    "msg"：
        {
            "areaId",1,
            "surveyId"：101,
            "results"：[
                [
                    {"questionId":1,"option":1},
                    ...
                ],
                ....
            ]
        }溯泣，
    
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
areaId| int | 1 | 游戲服id
surveyId| int | 101 | 問卷id
results| json | [[{"questionId":1,"option":1},...],...] | 結(jié)果列表

status為-1=獲取失敗群发。

4.38 獲取游戲里所有道具

接口名： Middleware.fetchItemList
說明：獲取游戲服中所有道具接口。
入?yún)⒄f明：如下：

字段名	類型	備注
gameId	int	基本參數(shù)
areaId	int	基本參數(shù)

返回：標(biāo)準(zhǔn)格式返回

{
    "code"：0发乔，
    "msg"：[
        {"itemDefId",10001101,"itemName"："裝飾物"}熟妓，
        ...
    ]
}

返回msg字典說明

字段名 | 類型 | 樣列 | 備注
--- | --- | ---
itemDefId| int | 10001101 | 道具定義的id
itemName| string | 裝飾物 | 道具名稱

最后編輯于：2017.12.03 03:54:06

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者

人面猴
序言：七十年代末，一起剝皮案震驚了整個濱河市栏尚，隨后出現(xiàn)的幾起案子起愈，更是在濱河造成了極大的恐慌，老刑警劉巖译仗，帶你破解...
沈念sama閱讀 217,907評論 6贊 506
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件抬虽，死亡現(xiàn)場離奇詭異，居然都是意外死亡纵菌，警方通過查閱死者的電腦和手機(jī)阐污，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 92,987評論 3贊 395
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來咱圆，“玉大人笛辟，你說我怎么就攤上這事⌒蛩眨” “怎么了手幢？”我有些...
開封第一講書人閱讀 164,298評論 0贊 354
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長忱详。經(jīng)常有香客問我围来，道長，這世上最難降的妖魔是什么匈睁？我笑而不...
開封第一講書人閱讀 58,586評論 1贊 293
?港島之戀（遺憾婚禮）
正文為了忘掉前任监透，我火速辦了婚禮，結(jié)果婚禮上航唆，老公的妹妹穿的比我還像新娘胀蛮。我一直安慰自己，他們只是感情好佛点，可當(dāng)我...
茶點故事閱讀 67,633評論 6贊 392
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布醇滥。她就那樣靜靜地躺著，像睡著了一般超营。火紅的嫁衣襯著肌膚如雪鸳玩。梳的紋絲不亂的頭發(fā)上，一...
開封第一講書人閱讀 51,488評論 1贊 302
城市分裂傳說
那天演闭，我揣著相機(jī)與錄音不跟，去河邊找鬼。笑死米碰，一個胖子當(dāng)著我的面吹牛窝革，可吹牛的內(nèi)容都是我干的购城。我是一名探鬼主播，決...
沈念sama閱讀 40,275評論 3贊 418
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼虐译，長吁一口氣：“原來是場噩夢啊……” “哼瘪板！你這毒婦竟也來了？” 一聲冷哼從身側(cè)響起漆诽，我...
開封第一講書人閱讀 39,176評論 0贊 276
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤侮攀，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后厢拭，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體兰英，經(jīng)...
沈念sama閱讀 45,619評論 1贊 314
?護(hù)林員之死
正文獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點故事閱讀 37,819評論 3贊 336
?白月光啟示錄
正文我和宋清朗相戀三年供鸠，在試婚紗的時候發(fā)現(xiàn)自己被綠了畦贸。大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
茶點故事閱讀 39,932評論 1贊 348
活死人
序言：一個原本活蹦亂跳的男人離奇死亡楞捂，死狀恐怖薄坏，靈堂內(nèi)的尸體忽然破棺而出，到底是詐尸還是另有隱情泡一，我是刑警寧澤颤殴，帶...
沈念sama閱讀 35,655評論 5贊 346
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布觅廓，位于F島的核電站鼻忠，受9級特大地震影響，放射性物質(zhì)發(fā)生泄漏杈绸。R本人自食惡果不足惜帖蔓，卻給世界環(huán)境...
茶點故事閱讀 41,265評論 3贊 329
男人毒藥：我在死后第九天來索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望瞳脓。院中可真熱鬧塑娇，春花似錦、人聲如沸劫侧。這莊子的主人今日做“春日...
開封第一講書人閱讀 31,871評論 0贊 22
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽烧栋。三九已至写妥，卻和暖如春，著一層夾襖步出監(jiān)牢的瞬間审姓，已是汗流浹背珍特。一陣腳步聲響...
開封第一講書人閱讀 32,994評論 1贊 269
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留魔吐，地道東北人扎筒。一個月前我還...
沈念sama閱讀 48,095評論 3贊 370
代替公主和親
正文我出身青樓莱找，卻偏偏與公主長得像，于是被迫代替她去往敵國和親嗜桌。傳聞我的和親對象是個殘疾皇子奥溺，可洞房花燭夜當(dāng)晚...
茶點故事閱讀 44,884評論 2贊 354

無標(biāo)題文章

后端中間件與游戲的設(shè)計分析

1. 需求概要

1.1 獲取游戲的所有服信息

1.2 玩家個人資料獲取以及更新

1.3 玩家基礎(chǔ)游戲數(shù)據(jù)

1.3.1 身份數(shù)據(jù)

1.3.2 玩家狀態(tài)

1.3.3 玩家實力

1.3.4 經(jīng)濟(jì)數(shù)據(jù)

1.3.5 游戲進(jìn)度

1.3.6 活躍度信息

1.4 教學(xué)（新手）引導(dǎo)

1.5 任務(wù)處理

1.6 成就處理

1.7 背包數(shù)據(jù)

1.8 充值訂單記錄

1.9 活動設(shè)置

1.10 賬號操作

1.11 補(bǔ)償操作

1.12 登陸公告管理

1.13 內(nèi)部郵件

1.14 手機(jī)消息推送

1.15 廣播處理

1.16 排行榜查詢

1.17 公會查詢

1.18 調(diào)查問卷

1.19 loading界面管理

2. 設(shè)計

2.1 各游戲請求地址配置

2.2 請求方式以及入?yún)⒏袷蕉x

2.2.1 請求方式

2.2.2 入?yún)⒄f明

2.3 請求的合法性校驗

2.4 返回結(jié)果說明

3. 基本參數(shù)說明

3.1 gameId

3.2 areaId

3.3 requestTime

4. 接口

4.1 獲取游戲所有服信息

4.2 搜索用戶

4.3 游戲用戶信息

4.4 更新用戶基本信息

4.5 獲取玩家游戲基礎(chǔ)數(shù)據(jù)

4.6 更新玩家游戲基礎(chǔ)數(shù)據(jù)

4.7 重置玩家所有游戲數(shù)據(jù)

4.8 獲取游戲所有教學(xué)引導(dǎo)清單

4.9 獲取用戶在游戲中引導(dǎo)的狀態(tài)

4.10 更新用戶在游戲中引導(dǎo)的狀態(tài)

4.11 獲取游戲所有任務(wù)清單

4.12 獲取用戶在游戲中任務(wù)清單

4.13 更新用戶在游戲中任務(wù)的狀態(tài)

4.14 獲取游戲所有成就清單

4.15 獲取用戶在游戲中成就列表

4.16 更新用戶在游戲中成就的狀態(tài)

4.18 獲取用戶在游戲中所有游戲數(shù)據(jù)列表

4.19 更新用戶在游戲中數(shù)據(jù)

4.20 刪除用戶在游戲中數(shù)據(jù)

4.21 獲取用戶的充值記錄

4.22 活動設(shè)置

4.23 道具檢查

4.24 獲取用戶的所有道具

4.25 道具派發(fā)

4.26 登錄公告設(shè)置

4.27 手機(jī)消息推送設(shè)置

4.28 系統(tǒng)廣播設(shè)置

4.29 loading界面管理

4.30 獲取排行榜查詢

4.31 公會查詢

4.32 公會詳情查詢

4.33 內(nèi)部郵件發(fā)送

4.34 實時補(bǔ)償

4.35 郵件補(bǔ)償

4.36 調(diào)查問卷管理/游戲答題

4.37 獲取問卷調(diào)查結(jié)果

4.38 獲取游戲里所有道具

推薦閱讀更多精彩內(nèi)容