[[TOC]]

= 家居杂志iPhone3.2.0 & iPad3.2.0 =
>mrobot代理环境说明： 
     192.168.10.198 端口为 1080 连的是QA测试环境(192.168.74.80)[[BR]] 
     192.168.10.199 端口为 1080 连的是dev40的开发环境（192.168.75.40）[[BR]] 
     '''ps:对于mrobot.pcauto.com.cn/x/前缀的接口，mrobot仅作代理，没有任何逻辑处理。''' [[BR]] 
     制作地址： [[BR]] 
     应用后端接口trac：
== 1.登录页提交用户信息 ==
----------


=== 1.1登录页提交用户信息 ===

>虚拟币开发环境：http://dev19.pchouse.com.cn:9090/loginTransfer/submitUserInfo.do [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/loginTransfer/submitUserInfo.do [[BR]]

> 非mrobot接口

**说明**

> 提交用户信息接口(用于人工转移虚拟币到新的手机账号) [[BR]]

**缓存时间**

> 分钟

**提交方式**

> POST

**是否登录**

> 是

**数据来源**

> 虚拟币

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=||
||= accountId =||= 通行证ID =||= String =||=  =||= 是 =||=  =||
||= mobile =||= 手机号码 =||= String =||=  =||= 是 =||=  =||
||= nickName =||= 昵称 =||= string =||=  =||= 是 =||=  =||

**返回**

{{{#!java
   {"message":"操作完成","statusCode":"200"}
}}}

**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||=参数含意=||
||= message=||= 回调说明 =||= statusCode =||= 状态码 =||

**错误提示**

> {"errorCode:1":"通行证ID有误或未登录或登录的passportId与参数accountId不一致","errorCode:2":"昵称为空","errorCode:200":"操作完成","errorCode:3":"手机号不能为空"}

----------

== 2.成为会员页 ==
----------


=== 2.1banner图片 ===

>mrobot地址：http://mrobot.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]
mrobot开发环境：http://dev40.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]

**说明**

> 提供一个图片的链接，上线后可以更换图片

**缓存时间**

>0

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

>mrobot后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||

**返回**

{{{#!java
{
    "vipBanner": "",
    "vipStep": "",
    "vipWalfare": "",
    "getScore": ""
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= vipBanner =||= 成为会员banner图 =||= vipStep =||= 成为会员步骤图 =||
||= vipWalfare =||= 会员福利图 =||= getScore =||= 获取积分图 =||

[[BR]]
=== 2.2成为会员步骤 ===

>mrobot地址：http://mrobot.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]
mrobot开发环境：http://dev40.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]

**说明**

> 提供一个图片的链接，上线后可以更换图片

**缓存时间**

>0

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

>mrobot后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||

**返回**

{{{#!java
{
    "vipBanner": "",
    "vipStep": "",
    "vipWalfare": "",
    "getScore": ""
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= vipBanner =||= 成为会员banner图 =||= vipStep =||= 成为会员步骤图 =||
||= vipWalfare =||= 会员福利图 =||= getScore =||= 获取积分图 =||

----------

== 3.会员福利列表 ==
----------


=== 3.1会员福利介绍图片 ===

>mrobot地址：http://mrobot.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]
mrobot开发环境：http://dev40.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]

**说明**

> 提供一个图片的链接，上线后可以更换图片

**缓存时间**

>0

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

>mrobot后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||

**返回**

{{{#!java
{
    "vipBanner": "",
    "vipStep": "",
    "vipWalfare": "",
    "getScore": ""
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= vipBanner =||= 成为会员banner图 =||= vipStep =||= 成为会员步骤图 =||
||= vipWalfare =||= 会员福利图 =||= getScore =||= 获取积分图 =||

[[BR]]
=== 3.2福利列表 ===
>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/welfare/list.do [[BR]]
mrobot开发环境：http://dev19.pchouse.com.cn:9090/welfare/list.do [[BR]]
mrobot线上环境：http://coin.pchouse.com.cn/welfare/list.do [[BR]]

**说明**

> 返回会员福利列表

**缓存时间**

>分钟

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

> 虚拟币

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= pageNo =||= 页码 =||= int =||= 1 =||= 否 =||
||= pageSize =||= 每页长度 =||= int =||= 20 =||= 否 =||

**返回**

{{{#!java
{
    "data":[{
        "title":"列表名称",
        "image":"列表图片链接（iPhone）",
        "imageBig":"列表图片链接（iPad）",
        "topicUrl":"链接",
        "type":"福利类型(html/bbs)"}],
    "pageNo":"当前的页数",
    "pageCount":"总页数"
}
}}}

**返回参数说明**
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
||= title =||= 列表名称 =||= image =||= 列表图片链接（iPhone） =||
||= imageBig =||= 列表图片链接（iPad） =||= topicUrl =||= 链接 =||
||= type =||= 福利类型(html/bbs) =||= =||= =||

----------

== 4.积分获取页 ==
----------


=== 4.1积分获取页 ===

>mrobot地址：http://mrobot.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]
mrobot开发环境：http://dev40.pcauto.com.cn/configs/pchouse_magazine_coin.json [[BR]]

**说明**

> 提供一个图片的链接，上线后可以更换图片

**缓存时间**

>0

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

>mrobot后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 说明 =||

**返回**

{{{#!java
{
    "vipBanner": "",
    "vipStep": "",
    "vipWalfare": "",
    "getScore": ""
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= vipBanner =||= 成为会员banner图 =||= vipStep =||= 成为会员步骤图 =||
||= vipWalfare =||= 会员福利图 =||= getScore =||= 获取积分图 =||

----------

== 5分享 ==
----------


=== 5.1积分兑换列表 ===

>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/exchange/list.do [[BR]]
虚拟币开发环境：http://dev19.pchouse.com.cn:9090/exchange/list.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/exchange/list.do [[BR]]

**说明**

> 返回积分兑换的礼品信息

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= mag =||= 杂志类型 =||= String =||=  =||= 是 =||==||
||= pageNo =||= 页码 =||= int =||=  =||= 否 =||
||= pageSize =||= 每页长度 =||= int =||= 10 =||= 否 =||

**返回**

{{{#!java
{
    "data": [
        {
            "id": "礼品id",
            "title": "礼品名称",
            "image": "礼品图片链接",
            "price": "礼品对应的幸福币数目",
            "typeGift": "礼品的类型material-实物virtual-虚拟物品",
            "type": "类型convert-兑奖select-抽奖"
        }
    ],
    "pageNo": "当前的页数",
    "pageCount": "总页数"
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= id =||= 礼品id =||= title =||= 礼品名称 =||
||= image =||= 礼品图片链接 =||= price =||= 礼品对应的幸福币数目 =||
||= typeGift =||= 礼品的类型material-实物virtual-虚拟物品 =||= type =||= 类型convert-兑奖select-抽奖 =||

**错误提示**
> {"errorCode:1": "pageNo参数有误","errorCode:2": "pageSize参数有误","errorCode:900": "杂志类型参数有误"}

[[BR]]
=== 5.2兑换礼品终端页 ===

>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/exchange/getGiftInfo.do [[BR]]
虚拟币开发环境：http://dev19.pchouse.com.cn:9090/exchange/getGiftInfo.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/exchange/getGiftInfo.do [[BR]]

**说明**
 
> 1）当用户没有登录的时候accountId不作为参数拼在接口后面，返回正常的礼品信息，当用户已经登录后accountId作为参数拼在接口后面，需要返回该礼品对应的状态信息  [[BR]]
2）其中礼品介绍以单个的类型在接口返回，没有这项介绍的传空

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 是

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= giftId =||= 礼品id =||= String =||=  =||= 是 =||==||
||= accountId =||= 用户的通行证id =||= String =||=  =||= 否 =||

**返回**

{{{#!java
[
    {
        "url": "礼品的图片链接",
        "name": "礼品的名称",
        "price": "礼品的价格",
        "time": "礼品的有效期（虚拟品）",
        "code": "礼品的兑换码（虚拟品）",
        "instr": "礼品兑换说明",
        "state":  "1：未兑换2：待发货3：已发货"
    },
    礼品介绍
]
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= url =||= 礼品的图片链接 =||= name =||= 礼品名称 =||
||= price =||= 礼品的价格 =||= time=||= 礼品的有效期（虚拟品） =||
||= code =||= 礼品的兑换码（虚拟品） =||= instr =||= 礼品兑换说明 =||
||= state =||= 状态：1：未兑换2：待发货3：已发货 =||=  =||=  =||

**错误提示**
> {"errorCode:1":"通行证ID有误或未登录 ","errorCode:2": "未输入礼品id","errorCode:3":"礼品不存在","errorCode:4":"礼品已经下架","errorCode:5":"礼品兑换类型不对"}

**错误提示**
> {"errorCode:1": "pageNo参数有误","errorCode:2": "pageSize参数有误","errorCode:900": "杂志类型参数有误"}

[[BR]]
=== 5.3抽奖礼品终端页 ===

>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/exchange/lottery/getGift.do [[BR]]
虚拟币开发环境：http://dev19.pchouse.com.cn:9090/exchange/lottery/getGift.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/exchange/lottery/getGift.do [[BR]]

**说明**
 
> 1）当用户没有登录的时候accountId不作为参数拼在接口后面，返回正常的礼品信息，当用户已经登录后accountId作为参数拼在接口后面，需要返回该礼品对应的状态信息 [[BR]]
2）其中礼品介绍以单个的类型在接口返回，没有这项介绍的传空 [[BR]]

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 是

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= giftId =||= 礼品id =||= String =||=  =||= 是 =||==||
||= accountId =||= 用户的通行证id =||= String =||=  =||= 否 =||

**返回**

{{{#!java
[
    {
        "url": "礼品的图片链接",
        "name": "礼品的名称",
        "price": "礼品的价格",
        "time": "礼品的有效期（虚拟品）",
        "code": "礼品的兑换码（虚拟品）",
        "instr": "礼品兑换说明",
        "result": "筛选结果（已获奖名单）",
        "state": "1：未参加抽奖2：抽奖中3：已中奖4：未中奖"
    },
    礼品介绍
]
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= url =||= 礼品的图片链接 =||= name =||= 礼品名称 =||
||= price =||= 礼品的价格 =||= time=||= 礼品的有效期（虚拟品） =||
||= code =||= 礼品的兑换码（虚拟品） =||= instr =||= 礼品兑换说明 =||
||= state =||= 状态：1：未兑换;2：待发货;3：已发货;4：未中奖 =||= result =||= 筛选结果（已获奖名单） =||

**错误提示**
> {"errorCode:1":"通行证ID有误或未登录 ","errorCode:2": "未输入礼品id","errorCode:3": "礼品不存在","errorCode:4": "礼品已经下架","errorCode:5": "礼品兑换类型不对"}

[[BR]]
=== 5.4兑换/抽奖提交信息 ===

>虚拟币开发环境：http://dev19.pchouse.com.cn:9090/interface/exchangeGift2.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/interface/exchangeGift2.do [[BR]]
非mrobot接口

**说明**
 
> 将用户姓名、手机号码、地址、邮编信息提供给后台 [[BR]]

**缓存时间**

>无

**提交方式**

> POST

**是否登录**

> 是

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= accountId =||= 通行证ID =||= String =||=  =||= 是 =||
||= address =||= 地址(发放实物礼品用) =||= String =||=  =||= 是 =||
||= exchangeNum =||= 兑换的个数 =||= String =||=  =||= 是 =||
||= giftId =||= 礼品id =||= String =||=  =||= 是 =||
||= mag =||= 杂志类型:pchouse pclady pcauto =||= String =||=  =||= 是 =||
||= phone =||= 电话(发放实物礼品用) =||= String =||=  =||= 是 =||
||= realName =||= 真实姓名(发放实物礼品用) =||= String =||=  =||= 是 =||
||= postNo =||= 邮编 =||= String =||=  =||= 是 =||

**返回**

{{{#!java
{"提交成功":"兑换/操作成功 "}
}}}
**返回参数说明**

**错误提示**
> {"errorCode:0":"通行证ID有误或未登录 ","errorCode:1":"虚拟币不足","errorCode:10":"你已经兑换过一次 请下期再来","errorCode:2":"礼品已经超过了兑换时间","errorCode:200":"参与成功请耐心等候礼品发放 ","errorCode:3":"礼品尚未开始兑换","errorCode:4":"礼品兑换完毕","errorCode:5":"礼品已经下架","errorCode:6":"礼品不存在","errorCode:7":"兑换的是实物礼品 必须填写地址 电话和真实姓名","errorCode:8":"往期成功兑换过奖品的用户不能参与此轮兑换，敬请期待下期奖品","errorCode:9":"杂志类型参数"}

[[BR]]
=== 5.5获取兑换/抽奖提交信息 ===

>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/interface/getSubmitedexchange.do [[BR]]
虚拟币开发环境：http://dev19.pchouse.com.cn:9090/interface/getSubmitedexchange.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/interface/getSubmitedexchange.do [[BR]]

**说明**
 
> 根据accountId来获取已经提交过信息用户的姓名、手机号码、地址、邮编信息

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 是

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= giftId =||= 礼品id =||= String =||=  =||= 是 =||==||
||= accountId =||= 用户的通行证id =||= String =||=  =||= 是 =||
||= mag =||= 杂志类型 pchouse pclady pcauto =||= String =||=  =||= 是 =||

**返回**

{{{#!java
[
    {
        "url": "礼品的图片链接",
        "name": "礼品的名称",
        "price": "礼品的价格",
        "time": "礼品的有效期（虚拟品）",
        "code": "礼品的兑换码（虚拟品）",
        "instr": "礼品兑换说明",
        "result": "筛选结果（已获奖名单）",
        "state": "1：未参加抽奖2：抽奖中3：已中奖4：未中奖"
    },
    礼品介绍
]
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= url =||= 礼品的图片链接 =||= name =||= 礼品名称 =||
||= price =||= 礼品的价格 =||= time=||= 礼品的有效期（虚拟品） =||
||= code =||= 礼品的兑换码（虚拟品） =||= instr =||= 礼品兑换说明 =||
||= state =||= 状态：1：未兑换;2：待发货;3：已发货;4：未中奖 =||= result =||= 筛选结果（已获奖名单） =||

**错误提示**
> {"errorCode:1":"通行证ID有误或未登录 ","errorCode:2": "未输入礼品id","errorCode:3": "礼品不存在","errorCode:4": "礼品已经下架","errorCode:5": "礼品兑换类型不对"}

[[BR]]
=== 5.6我的礼品列表 ===

>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/exchange/giftList.do [[BR]]
虚拟币开发环境：http://dev19.pchouse.com.cn:9090/exchange/giftList.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/exchange/giftList.do [[BR]]

**说明**
 
> 获取用户参与过的所有礼品信息

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 是

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= giftId =||= 礼品id =||= String =||=  =||= 是 =||==||
||= accountId =||= 用户的通行证id =||= String =||=  =||= 是 =||
||= mag =||= 杂志类型 pchouse pclady pcauto =||= String =||=  =||= 是 =||

**返回**

{{{#!java
[
{
    "data": [
        {
            "title": "礼品名称",
            "image": "礼品图片链接",
            "price": "礼品对应的幸福币数目",
            "expressId": "快递号",
            "code": "兑换码（虚拟品）",
            "time": "有效期（虚拟品）",
            "state": "礼品的状态(兑奖类: 2-待发货3-已发货;抽奖类: 2-抽奖中3-已中奖4-未中奖)",
            "typeGift": "礼品的类型material-实物virtual-虚拟type: 礼品的兑换类型convert-兑奖select-抽奖"
        }
    ],
    "pageNo": "当前的页数",
    "pageCount": "总页数"
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= title =||= 礼品名称 =||= image =||= 礼品图片链接 =||
||= price =||= 礼品对应的幸福币数目 =||= expressId =||= 快递号 =||
||= code =||= 礼品的兑换码（虚拟品） =||= time =||= 有效期（虚拟品） =||
||= state =||= 状态：1：未兑换;2：待发货;3：已发货;4：未中奖 =||= typeGift =||= 礼品的类型material-实物virtual-虚拟type: 礼品的兑换类型convert-兑奖select-抽奖 =||

**错误提示**
> {"errorCode:1":"通行证ID有误或未登录 ","errorCode:2": "页码参数有误 ","errorCode:3": "每页大小参数有误 ","errorCode:900":"杂志类型参数有误"}

[[BR]]
=== 5.7新手指南 ===

>mrobot地址： [[BR]]


**说明**
 
> 提供一个新手指南的链接

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

> mrobot后台

**参数**

**返回**

> HTML

**返回参数说明**


----------

== 6获取幸福币后台用户的详细信息 ==
----------


=== 6.1获取幸福币后台用户的详细信息 ===

>mrobot地址：http://mrobot.pcauto.com.cn/xsp/x/coin.pchouse.com.cn/user/getUserInfo.do [[BR]]
虚拟币开发环境：http://dev19.pchouse.com.cn:9090/user/getUserInfo.do  [[BR]]
虚拟币线上环境：http://coin.pchouse.com.cn/user/getUserInfo.do [[BR]]

**说明**

> 获取用户虚拟币后台的详细信息，包括用户的昵称、手机号码、幸福币数目等

**缓存时间**

>无

**提交方式**

> GET

**是否登录**

> 是

**数据来源**

> 虚拟币后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||= account =||= 用户的通行证id =||= String =||=  =||= 是 =||==||
||= mag =||= 杂志类型 =||= String =||=  =||= 是 =||

**返回**

{{{#!java
{
    "username": "用户的名称",
    "userphone": "用户的手机号码",
    "usercoin": "用户对应杂志幸福币数"
}
}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||= 参数名 =||= 参数含意 =||
||= username =||= 用户的名称 =||= userphone =||= 用户的手机号码 =||
||= usercoin =||= 用户对应杂志幸福币数 =||=  =||=  =||

**错误提示**
> {"errorCode:1":"通行证ID有误或未登录 ","errorCode:900": "杂志类型参数有误"}