闪页可配置接口设计文档

开发设计

• 闪页可配置
  用于描绘客户端响应服务端的某些特定行为的UI呈现及响应，该API返回结构与推送结构设计兼容。

接口名：pd.global.splashscreen
接口描述：获取闪页的配置信息。
参数：
    sessionId；(必填)
返回：
{
    "success": true,
    "msgCode": null,
    "msgInfo": null,
    "count": 0,
    "model": {
        "vendor":12,//大参林
        "ui": {
            "background": "闪页背景图片的地址",    // string
            "start": "何时呈现的时间戳（秒级）",    // long 单位秒
            "end": "结束呈现的时间戳（秒级）"       // long 单位秒
        },
        "target": {
            "type": "open_discover" // 行为类型
        },
        "desc": {},
        "extras": {
            "discover": {           // 行为参数
                "url": "http://www.163.com/"
            }
        },
        "type": "splashscreen",     // 新增类型
        "id": 2
    }
}

业务调用：

1. 该接口设计的目的是为了配合运营活动（广告），所以要求运营提前配置，给客户端充分的缓存图片及指令的时机。
2. 客户端检查本地是否有缓存响应：
   

   若有缓存：
   1、检查是否是当前的合作商
   2、若是当前合作商，则根据是否在显示的窗口期内，决定闪页呈现。
   3、若非当前合作商，则默认显示扑咚的闪页
   若无缓存
   1、则默认显示扑咚的闪页。

3. 客户端异步调用“闪页配置接口”，返回结果如上。

4. 得到响应后，依次检查如下：

   若客户端缓存的响应已过期，则先清空响应及缓存图片。
   若客户端缓存的响应未过期，则比对响应与服务端的响应是否一致。若一致，则不做任何操作。若不一致，则缓存响应与图片。