[[TOC]]

== 一.基本约定 ==

{{{
  1.开发机、测试机代理地址：
  mrobot开发机代理：192.168.10.199  端口：1080
  mrobot测试机代理：192.168.10.198  端口：1080
  
  2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。
  
  3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。
      {
         "desc":"给用户的提示放在这里"
      }
      
  4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。
  
  5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。
  
  6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号
  
  7.需要分页的接口，统一返回以下字段:  pageNo,pageSize,total
  
  8.涉及接口都增加请求参数：v = 220  //版本号(数字)

  9.发帖，回帖中status字段值的含义如下：

	STATUS_ERROR = -1;			        //错误
	STATUS_SUCCESS = 0;				//成功
	STATUS_NO_RIGHT = 1;				//没有权限
	STATUS_PARAM_WRONG = 2;			        //参数错误
	STATUS_CONTENT_OVERFLOW = 3;	                //内容超出长度
	STATUS_EXISTS = 4;				//数据已经存在
	STATUS_NOT_FOUND = 5;				//数据查找不到
        STATUS_NO_LOGIN = 6;    			//没有登录
        STATUS_USER_LOCK = 7;    			//用户被锁

        当status不等于0时，具体原因参照message字段的说明。
}}}

== 二.接口列表 ==
=== 1.0 启动页广告 ===
{{{
  说明：查询启动页广告的接口
  mrobot接口URL：
  后端接口URL：
  HTTP请求方式：GET
  是否需要登录：否
  返回格式：JSON
  缓存方式：无
  缓存时间：无
  请求参数：无

  返回结果:
{
   "pclady.app.startup"://启动页广告
    {
        "ad":
        {
            "cc-uri": "", //点击计数：点击一次，计数一次
            "cc3d-uri":"",
            "img":"http://imgad0.pcauto.com.cn/ivy/image/20149/5/14099100976890.jpg",
            "to-uri":"", //跳转的url
            "vc-uri":"http://ivy.pcauto.com.cn/adpuba/show?adid=333659&id=auto.khd.zx.qdtdh.&media=js", //显示计数：显示一次，计数一次
            "vc3d-uri":""
        },
        "rule":
        {
            "age":1,     //进入页面1秒后开始显示广告
            "delay":5,  //广告显示时长：5秒
            "interval":10 //进入同一终端页间隔<10s，不显示广告
        }
    }
}
}}}

=== 2.0 首页广告 ===
{{{
  说明：查询首页广告的接口
  mrobot接口URL：
  后端接口URL：
  HTTP请求方式：GET
  是否需要登录：否
  返回格式：JSON
  缓存方式：无
  缓存时间：无
  请求参数：无

  返回结果:
{
   "pclady.app.homepage": {//首页广告
        "ad": {
            "cc-uri": "",
            "cc3d-uri": "",
            "image": "http://imgad0.pcbaby.com.cn/ivy/image/20153/30/14276788853330.jpg",
            "to-uri": "http://ivy.pcbaby.com.cn/adpuba/click?adid=361212&id=pckids.app.qzbd.cyt.sy.tl.",
            "vc-uri": "http://ivy.pcbaby.com.cn/adpuba/show?adid=361212&id=pckids.app.qzbd.cyt.sy.tl.&media=js",
            "vc3d-uri": ""
        }
    }
}


}}}


=== 3.0 文章页广告 ===
{{{
  说明：查询首页广告的接口
  mrobot接口URL：
  后端接口URL：
  HTTP请求方式：GET
  是否需要登录：否
  返回格式：JSON
  缓存方式：无
  缓存时间：无
  请求参数：无

  返回结果:
{
   "pclady.app.article": {//文章页广告
        "ad": {
            "cc-uri": "",
            "cc3d-uri": "",
            "image": "http://imgad0.pcbaby.com.cn/ivy/image/20153/30/14276788853330.jpg",
            "to-uri": "http://ivy.pcbaby.com.cn/adpuba/click?adid=361212&id=pckids.app.qzbd.cyt.sy.tl.",
            "vc-uri": "http://ivy.pcbaby.com.cn/adpuba/show?adid=361212&id=pckids.app.qzbd.cyt.sy.tl.&media=js",
            "vc3d-uri": ""
        }
    }
}


}}}
----------