wiki:pclady_news2.0.1_api

Version 19 (modified by caomenglin, 10 years ago) (diff)

--

Choice(悦选)2.0.1接口文档

mrobot代理环境说明:

192.168.10.198:1080(192.168.74.80)
192.168.10.199 端口为 1080 连的是dev40的开发环境(192.168.75.40)
ps1:未到qa阶段,连开发环境调试(若仅做代理,mrobot不存在真正的处理文件,只作转发的功能)
ps2:common_session_id都是在cookies中添加此参数

 框架
 2.0.0接口地址

1.广告


1.1广告

开发环境: http://dev40.pclady.com.cn/s/choice/ad/ad.xsp?v=2.0.1
线上环境: http://mrobot.pclady.com.cn/s/choice/ad/ad.xsp?v=2.0.1

缓存时间

提交方式

GET

数据来源

广告系统

参数

参数名 参数含义 类型 默认值 是否必须 说明
v 版本号 string app版本号 x.x.x

返回

{
    "twlb1": [//文章列表通栏
        {
            "seq": "3",
            "vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=391573&id=test.adtest.sytl.&media=js",
            "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=391573&id=test.adtest.sytl.",
            "vc3d-uri": "",
            "cc3d-uri": "",
            "cc-uri": ""
        }
    ],
    "pclady.yx.qdt.": {//启动页
        "rule": {
            "delay": "3",
            "age": "3",
            "interval": "0"
        },
        "ad": {
            "image": "http://img0.pconline.com.cn/ivy/image/20157/29/14381360355610.jpg",
            "vc-uri": "http://1.1.1.1?a=11",
            "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=391573&id=test.adtest.qdt.",
            "vc3d-uri": "http://1.1.1.1?a=12",
            "cc3d-uri": "http://1.1.1.1?a=13",
            "cc-uri": ""
        }
    },
    "grzxtj": [//个人中心
        {
            "image": "http://img0.pconline.com.cn/ivy/image/20162/26/14564551982930.jpg",
            "title": "个人中心推荐1测试",
            "seq": "3",
            "vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=391573&id=test.adtest.grzxtj1.&media=js",
            "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=391573&id=test.adtest.grzxtj1.",
            "vc3d-uri": "",
            "cc3d-uri": "",
            "cc-uri": ""
        },
        {
            "image": "http://img0.pconline.com.cn/ivy/image/20162/26/14564551982930.jpg",
            "title": "个人中心推荐2",
            "seq": "3",
            "vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=391572&id=test.adtest.grzxtj2.&media=js",
            "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=391572&id=test.adtest.grzxtj2.",
            "vc3d-uri": "",
            "cc3d-uri": "",
            "cc-uri": ""
        }
    ],
    "mrpt1": [//首页配图
        {
            "seq": "3",
            "image": "http://imgad0.3conline.com/ivy/image/201212/5/13546779846420.jpg",
            "vc-uri": "http://ivy.pconline.com.cn/adpuba/show?adid=391571&id=test.xwx.wap.mrpt.&media=js",
            "to-uri": "http://ivy.pconline.com.cn/adpuba/click?adid=391573&id=test.adtest.sypt.",
            "vc3d-uri": "",
            "cc3d-uri": "",
            "cc-uri": ""
        }
    ]
}


1.2启动页 (新增)

开发环境: http://dev15.pclady.com.cn:8004/app/launch.jsp
线上环境: http://choice.pclady.com.cn/app/launch.jsp
mrobot地址:

 http://dev40.pclady.com.cn/s-900/choice/cms/launch.xsp

 http://mrobot.pclady.com.cn/s-900/choice/cms/launch.xsp

说明

启动页

缓存时间

15分钟

提交方式

GET

数据来源

整形库

修改内容

参数

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

返回

{
    "status": 0,//没广告时返回-1
    "msg": "请求成功",
    "imageUrl": "http: //img.pconline.com.cn/7.jpg"
}

返回参数说明


1.3文章终端页 (修改)

(接口已经完成,请连开发机进行测试)
开发环境: http://dev15.pclady.com.cn:8004/app/articleInfo.jsp
线上环境: http://choice.pclady.com.cn/app/articleInfo.jsp

mrobot地址: http://mrobot.pclady.com.cn/s-300/choice/cms/articles.xsp?articleID=197&terminal=1&deviceID=abc
制作地址: http://zzsvn.pcauto.com.cn/svn/pclady/mobile/2015/zxapp/zxxq.html
修改说明

返回参数添加图片数据,imageList ,imageList中的图为文章头图+文章页里面的图片
图片点击添加协议pcladybrowser://album-photo/index,index表示点击imageList中的第XX张。文章头图index=0,文章页从1开始
文章图片点击由mrobot添加,协议为pcladybrowser://album-photo/0

JS函数

support(cmtId) 用于实现评论点赞+1动画。cmtId为评论id
pershow(zan, cai) 未点赞和点未踩时调用。zan为总赞数,cai为总踩数
operate(type, zan, cai) 用于点赞或者点踩。type为0时点赞,type为1时点踩,zan为总赞数,cai为总踩数。

缓存时间

mrobot与后台都为5分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
articleID 文章ID string ""
terminal 1:iOS 2:Android int 0
fmt fmt=json时直接返回后台json,fmt=wap时返回分享格式的文章终端页,为空时返回客户端使用的文章终端页 String""
appVersion= 版本号 string "" 如200
inReview= 1:审核状态 0:发布状态int 0 ios审核时用到
deviceID 设备ID string "" 根据设备号判定
preview 是否用于后台预览文章 int "" 为1时用于后台预览文章

返回

{
  "status":0,
  "msg":"请求成功",
  "articleID":"文章ID",
  "url":"文章url"//参考文档开头的评论url格式
  "authorID":"作者ID",
  "authorName":"作者昵称",
  "authorUrl":"作者头像",
  "authorWXID":"作者微信订阅号",
  "headImageUrl":"文章头图",
  "title":"文章标题",
  "collectCount":"100",
  "supportCount":"100",//总的点赞数
  "opposeCount":"50",//总的点踩数
  "supportState":"0",
  "sysTime":"系统当前时间YYYY-MM-DD HH:mm:ss",
  "html":"文章html文本",
  "desc":"文章内容纯文本前40个字",
  "secondarySpecialList":[
    {//相关二级专题
      "secondarySpecialID":"二级专题ID",
      "secondarySpecialName":"二级专题名称",
      "secondarySpecialText":"二级专题简介文本"
      "articleCount":"文章篇数",
      "followCount":"关注人数",
      "imageUrl":"专题图片"
    },
    ......
  ],
  "tagList":[
    {
      "tagID":"标签ID",
      "tagText":"标签文本"
    }
  ]
 "imageList":[
   "image1","image2"
]
}

mrobot返回的html中的json
/*@_HTML_META_START_
{
  "collectCount":"100",
  "commentCount":"50",
  "message":"文章html文本前40个字",
   "imageUrl":"文章头图",
    "title":"文章标题",
    "secondarySpecialNameList":["名称1","名称2"],
    "imageList":[
      "image1","image2"
    ]
}
_HTML_META_END_@*/

返回参数说明

参数名 参数含义 参数名参数含意
collectCount 文章被收藏次数 commentCount 文章评论数量
supportState 0:未点赞未踩,1:已点赞,2:已踩

1.4文章或活动是否被用户收藏

开发环境: http://dev15.pclady.com.cn:8004/app/isCollected.jsp
线上环境: http://choice.pclady.com.cn/app/isCollected.jsp
mrobot地址:  http://mrobot.pclady.com.cn/x/choice-choice/app/isCollected.jsp?ID=311&type=1

修改说明

添加两个返回参数,收藏和评论数[BR]]

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
ID 对象id string ""
type 对象类型 int "" 1:文章,2:活动

返回

{
  "status":0,
  "msg":"请求成功",
  "hasCollected":"1",
   "collectCount":"100",
  "commentCount":"50",

}

返回参数说明

参数名 参数含义 参数名参数含意
hasCollected 0:未收藏,1:已收藏 collectCount 收藏数 用户未登录时也需要返回
commentCount 评论数 用户未登录时也需要返回