wiki:pclady_news2.0.0_api

Version 162 (modified by fuxingfang, 10 years ago) (diff)

--

Choice(悦选)2.0.0接口文档

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中添加此参数

 框架
 设计稿地址
 终端协议
 评论系统接口

评论用到的URL:

文章  http://pclady.com.cn/pcladynews/article/id.html
投票/活动  http://pclady.com.cn/pcladynews/activity/id.html

1.首页


1.1资讯首页

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

说明

获取资讯栏目的首页精选数据。
列表中的文章数据按天(服务器时间)进行分页,每次返回的数据为某一天的文章数据,参数中用date来标识,如果date为空表示加载当天数据,随后后端返回数据时需要一同返回这些数据是属于哪天的,以及有数据的下一天的日期nextDate。
数据异常机制:当天必须要有焦点文章,如果没有焦点文章,即使有文章数据也跳过该天,随后返回最近有焦点文章那天的文章列表。假如已经到了最后一天,nextDate返回为空。

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
date指定日期string"" 为空时返回服务器当天数据,随后使用后端返回的nextDate来请求,格式YYYY-MM-DD

返回

{
  "status":0,
  "msg":"请求成功",
  "data":{
    "date":"数据所属日期",//YYYY-MM-DD
    "nextDate":"下次请求的日期",//YYYY-MM-DD
    "focusArticle":{  //焦点文章
      "authorID":"作者ID",
      "authorName":"作者昵称",
      "authorUrl":"作者头像",
      "articleID":"文章id",
      "imageUrl":"文章图片",
      "title":"文章标题",
      "desc":"文章正文前80字",
      "focusImageUrl":"焦点文章图片"  //为文章配置的焦点图
    },
    "articleList":[
      { 
        "specialID":"所属一级专题ID",
        "specialName":"所属一级专题名称",
        "authorID":"作者ID",
        "authorName":"作者昵称",
        "authorUrl":"作者头像",
        "articleID":"文章id",
        "imageUrl":"文章图片",
        "title":"文章标题",
        "desc":"文章正文前80字"
      }
    ],
    "focusImage":{  //焦点图
      "focusID":"焦点图ID",
      "imageUrl":"焦点图片",
      "desc":"焦点图简介"
    }
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
authorName 作者昵称 authorID 作者ID
focusDate 焦点图上显示的时间


1.2文章终端页 (WEB)

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

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

获取指定文章终端页的内容
应用端出相关数据与文章html,wap页由mrobot来完成。评论数据从评论系统获取,参考  评论系统接口

JS函数

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

缓存时间

60分钟

提交方式

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 "" 根据设备号判定

返回

{
  "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":"标签文本"
    },
    ......
  ]
}

mrobot返回的html中的json
/*@_HTML_META_START_
{
  "collectCount":"100",
  "commentCount":"50",
  "message":"文章html文本前40个字",
   "imageUrl":"文章头图",
    "title":"文章标题"
}
_HTML_META_END_@*/

返回参数说明

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


1.3标签文章列表

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

说明

点击标签后,获取带有该关键字的文章列表,app不作缓存

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
tagID标签IDstring
pageNo页数int1
pageSize页面大小int20

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "tagName":"标签名"
  "data":[
      { 
        "specialID":"所属一级专题ID",
        "specialName":"所属一级专题名称",
        "authorID":"作者ID",
        "authorName":"作者名称",
        "authorUrl":"作者头像",
        "articleID":"文章ID",
        "title":"文章标题",
        "imageUrl":"文章图片"
      }
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意
authorID 作者ID authorName 作者名称


1.4文章评论列表 (WEB)

(接口已经完成,请连开发机进行测试)
mrobot地址: http://mrobot.pclady.com.cn/s/choice/cms/comments.xsp?url=http://pclady.com.cn/pcladynews/article/197.html&pageNo=1&pageSize=5&reverse=0
制作搞地址: http://zzsvn.pcauto.com.cn/svn/pclady/mobile/2015/zxapp/comment.html

说明

获取文章评论列表

JS函数

support(cmtId) 用于实现评论点赞+1动画。cmtId为评论id

缓存时间

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
url 文章url string "" 文章url
pageNo 第几页 int 1 第几页
pageSize 每页显示的条数 int 20 每页显示的条数
reverse 排序方式 int 0 0 倒序; 1 正序

返回 mrobot返回的html中的json

/*@_HTML_META_START_
{
  "pageNo": 1, 
  "pageSize": 10,
  "total": 100
}
_HTML_META_END_@*/


1.5评论点赞

经评论系统
url: http://cmt.pclady.com.cn/action/comment/support_json.jsp

说明

对评论进行点赞

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

参数

参数名 参数含义 类型 默认值 是否必须 说明
cid 评论ID string ""
sp 点赞操作 string "" >0代表点赞 ,<=0代表反对

返回

        {
            "support": 2,
            "floor": 2,
            "status": 0,
            "topicId": 13205153,
            "postId": 36813920
        }
        
        {
            message: "您已对该评论投过票,不可重复投票",
            status: -1
        }

返回参数说明

参数名 参数含义 参数名参数含意


1.6评论发送

经评论系统
url: http://cmt.pcauto.com.cn/action/comment/create_utf8.jsp

说明

评论列表页中发表评论

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

参数

参数名 参数含义 类型 默认值 是否必须 说明
id 话题id string ""
url 话题url string ""
username 用户名 string ""
anonymous 是否匿名 string ""
content 回复内容 string "" 回复内容
common_session_id 太平洋通行证session string "" cookies中添加
replyFloor2 回复楼层 string "" 时尚胶囊暂时不支持二级评论,故此参数可以无视

返回

{
    "commentId":25705754,
    "floor":27,
    "showName":"iostester",
    "brief":"Really&nbsp;good&nbsp;car&nbsp;hm~~~",
    "status":0,
    "createTime":"2013-07-19 10:37:03",
    "resultCode":0,
    "resultMsg":"您的评论已经成功发表。注:评论在审核后才能出现在列表中,谢谢!",
    "userId":25520497
}

返回参数说明

参数名 参数含义 参数名参数含意


1.7焦点图和文章点赞、踩

开发环境: http://dev15.pclady.com.cn:8004/app/support.jsp
线上环境: http://choice.pclady.com.cn/app/support.jsp

说明

对焦点图或文章进行点赞或踩。如果焦点页未被赞、踩,那么则对焦点页进行赞、踩操作。如果已赞或已踩,则切换赞、踩状态,不能取消点赞或取消踩。 客户端控制重复操作不发送请求。

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
ID 对象ID string ""
type 被点赞对象类型 int "" 1:文章,2:焦点图
sp 操作类型 int "" 1:点赞,2:踩
deviceID 设备ID string "" 根据设备号判定

返回

{
  "status":0,
  "msg":"请求成功"
}

返回参数说明

参数名 参数含义 参数名参数含意


1.8焦点图、文章点赞、踩状态查询

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

说明

查询某设备或用户对某焦点图或某文章的点赞、踩状态,如果查询的是文章,需要分别返回点赞和踩的数量

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
ID 对象id string ""
type 查询对象类型 int "" 1:文章,2:焦点图
deviceID 设备ID string "" 根据设备号判定

返回

{
  "status":0,
  "msg":"请求成功",
  "state":"0",
  "supportCount":"100",//总的点赞数
  "opposeCount":"50"//总的点踩数

}

返回参数说明

参数名 参数含义 参数名参数含意
supportCount 文章点赞数 opposeCount 文章踩数
state 0:未点赞未踩,1:已点赞,2:已踩


1.9文章或活动收藏

开发环境: http://dev15.pclady.com.cn:8004/app/collect.jsp
线上环境: http://choice.pclady.com.cn/app/collect.jsp

说明

收藏或取消收藏指定文章,根据参数type区分

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

编辑后台

参数

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

返回

{
  "status":0,
  "msg":"收藏成功"
}
{
  "status":1,
  "msg":"取消收藏成功"
}
{
  "status":-1,
  "msg":"失败原因"
}

返回参数说明

参数名 参数含义 参数名参数含意


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

开发环境: 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

说明

获取该文章或活动是否已被用户收藏

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

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

返回

{
  "status":0,
  "msg":"请求成功",
  "hasCollected":"1"
}

返回参数说明

参数名 参数含义 参数名参数含意
hasCollected 0:未收藏,1:已收藏

2.专题


2.1专题频道页

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

说明

获取专题首页中我的专题、热门专题、其他专题列表
我的专题中显示我订阅专题内最新更新的一篇文章,以及自上一次进入我的订阅页面后累计更新的文章数,若用户无订阅任何专题或未登录,不需要返回此节点
热门专题列表读取后台中设定的3个热门专题
其他专题列表读取后台中设定的专题,若干个一级专题,一级专题下有4个露出二级专题

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo 页码 int 1 当pageNo为1时需要返回我的专题和热门专题
pageSize 每页行数 int 10

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 10,
  "total": 100,
  "data":{
    "mySpecial":{  //我的专题,如果没登陆,或者用户没关注,则不需要返回
      "newCount":"已更新文章数"
    },
    "hotSpecial":[  //热门二级专题,3个
      { 
        "secondarySpecialID":"专题ID",
        "secondarySpecialName":"专题名称",
        "articleCount":"文章篇数",
        "followCount":"关注人数",
        "imageUrl":"专题图片"
      },
      ......
    ],
    "specialList":[    //一级专题列表中包含3个二级专题
      {
        "specialID":"专题ID",
        "specialName":"专题名称",
        "specialNameEn":"专题英文名称",
        "secondaryCount":"二级专题总数量",
        "secondaryList":[
          { 
            "secondarySpecialID":"专题ID",
            "secondarySpecialName":"专题名称",
            "articleCount":"文章篇数",
            "followCount":"关注人数",
            "imageUrl":"专题图片"
          },
          ......
        ]
      },
      ......
    ]
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
authorName 作者名称 authorID 作者ID
pageNo 一级专题的pageNo pageSize 一级专题的pageSize
total 一级专题的总数 newCount 我的订阅中新文章数量


2.2专题主页

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

说明

获取指定专题的专题介绍栏、文章列表
app不作缓存

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
secondarySpecialID 二级专题ID string ""
pageNo 内容页数 int 1 为1时需要返回专题介绍栏、分类标签栏
pageSize 内容页数 int 20

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":{
    "introduce":{  //二级专题介绍栏
      "secondarySpecialID":"二级专题ID",
      "secondarySpecialName":"二级专题名称",
      "secondarySpecialText":"专题简介文本",
      "imageUrl":"专题图片",
      "articleCount":"专题文章篇数",
      "followCount":"专题关注人数",
      "authorCount":"专题作者人数"
    },
    "articleList":[    //专题中的内容列表,不包括分类标签栏中的那篇
      {
        "authorID":"作者ID",
        "authorName":"作者昵称",
        "authorUrl":"作者头像",
        "articleID":"文章id",
        "imageUrl":"文章图片",
        "title":"文章标题",
        "specialName":"所属一级专题名称"
      },
      ......
    ]
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
authorName 作者名称 authorID 作者ID
specialName 文章所属专题的分类名称
articleCount 该专题下的文章数量 followCount 该专题下的关注人数
authorCount 该专题下的作者人数


2.3所有专题页

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

说明

获取指定一级专题下的二级专题列表
app不作缓存

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
specialID 一级专题id string ""
pageNo 内容页数 int 1
pageSize 内容页数 int 15

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 15,
  "total": 100,
  "data":{
    "specialName":"专题名称",
    "specialNameEn":"专题英文名称",
    "specialText":"一级专题的介绍文本",
    "specialList":[
      {
        "secondarySpecialID":"专题ID",
        "secondarySpecialName":"专题名称",
        "secondarySpecialText":"专题简介文本",
        "imageUrl":"专题图片",
        "articleCount":"文章篇数",
        "followCount":"关注人数"
      },
      ......
    ]
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
specialText 一级专题的描述信息,显示在标题中
articleCount 该专题下的文章数量 followCount 该专题下的关注人数


2.4订阅专题

开发环境: http://dev15.pclady.com.cn:8004/app/subscribeSpecial.jsp
线上环境: http://choice.pclady.com.cn/app/subscribeSpecial.jsp

说明

登陆后订阅二级专题

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
secondarySpecialID 二级专题id string ""

返回

{
  "status":0,
  "msg":"已成功订阅"
}
{
  "status":0,
  "msg":"已取消订阅"
}


返回参数说明

参数名 参数含义 参数名参数含意


2.5专题是否已被用户订阅

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

说明

获取该专题是否已被用户订阅

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
secondarySpecialID 二级专题id string ""

返回

{
  "status":0,
  "msg":"请求成功",
  "hasSubscribed":"1"
}

返回参数说明

参数名 参数含义 参数名参数含意
hasSubscribed 0:未订阅,1:已订阅


3.互动


3.1活动频道页

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

说明

读取活动列表,20条一组 app不做缓存

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo页数int1
pageSize页面大小int20

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[
      { 
        "activityID":"活动ID",
        "activityName":"活动名称",
        "activityType":"活动类型",
        "userCount":"参与用户人数",
        "date":"活动发布日期"
        "imageUrl":"活动图片",
        "desc":"活动简介前80字"
      },
      ......
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意
activityType 1:投票,2:话题


3.2投票活动详情页 (WEB)

(接口已经完成,请连开发机进行测试)

开发环境: http://dev15.pclady.com.cn:8004/app/voteInfo.jsp
线上环境: http://choice.pclady.com.cn/app/voteInfo.jsp
mrobot地址:  http://mrobot.pclady.com.cn/s-900/choice/cms/activity_votes.xsp
制作地址:  http://zzsvn.pcauto.com.cn/svn/pclady/mobile/2015/zxapp/hdxq.html
制作地址:  http://zzsvn.pcauto.com.cn/svn/pclady/mobile/2015/zxapp/voteResult.html
说明

投票详情页,应用端返回投票页详情,mrobot端组装wap页 评论数据从评论系统获取,参考  评论系统接口
可重复投票,从app分享出去的wap页仍可以投票,点击投票后按钮文本提示改为打开app查看投票结果。

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
activityID 活动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 "" 根据设备号判定

返回

{
  "status":0,
  "msg":"请求成功",
  "activityID":"活动ID",
  "url":"文章url",//参考文档开头的评论url格式
  "activityType":"活动类型",
  "activityTitle":"活动标题",
  "activityDesc":"活动简介",
  "imageUrl":"活动图片",
  "totalCount":"参与人数",
  "collectCount":"100",
  "optionList":[//投票选项、投票结果
    {
      "optionID":"选项ID",
      "optionTitle":"选项标题",
      "optionImageUrl":"选项图片",
      "voteCount":"100"//投票人数
    },
    ......
  ]
}

mrobot返回的html中的json
/*@_HTML_META_START_
{
  "collectCount":"100",
  "commentCount":"50",
  "message":"活动简介前40个字",
   "imageUrl":"文章头图",
   "title":"文章标题"
}

_HTML_META_END_@*/

返回参数说明

参数名 参数含义 参数名参数含意
collectCount 文章被收藏次数 commentCount 文章评论数量
totalCount 总参与人数,投票活动指的是参与投票的人数


3.3话题活动详情页(WEB)

(接口已经完成,请连开发机进行测试)
开发环境: http://dev15.pclady.com.cn:8004/app/topicInfo.jsp
线上环境: http://choice.pclady.com.cn/app/topicInfo.jsp
mrobot地址:  http://mrobot.pclady.com.cn/s-3600/choice/cms/activity_topics.xsp?activityID=141&terminal=1&deviceID=abcd
制作地址: http://zzsvn.pcauto.com.cn/svn/pclady/mobile/2015/zxapp/topic.html

说明

话题详情页,应用端返回话题页详情,mrobot端组装wap页 评论数据从评论系统获取,参考  评论系统接口

JS函数

support(cmtId) 用于实现评论点赞+1动画。cmtId为评论id

缓存时间

60分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
activityID 活动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 "" 根据设备号判定

返回

{
  "status":0,
  "msg":"请求成功",
  "activityID":"活动ID",
  "url":"url",//参考文档开头的评论url格式
  "activityType":"活动类型",
  "activityTitle":"活动标题",
  "activityDesc":"活动简介",
  "imageUrl":"活动图片",
  "totalCount":"参与人数",
  "collectCount":"100",
  "html":"话题正文html"
}

mrobot返回的html中的json
{
/*@_HTML_META_START_
  "collectCount":"100",
  "commentCount":"50",
  "message":"活动简介前40个字",
  "imageUrl":"文章头图",
   "title":"文章标题"
}
_HTML_META_END_@*/

返回参数说明

参数名 参数含义 参数名参数含意
collectCount 文章被收藏次数 commentCount 文章评论数量
totalCount 总参与人数,话题活动指的是评论总数


3.4投票

开发环境: http://dev15.pclady.com.cn:8004/app/vote.jsp
线上环境: http://choice.pclady.com.cn/app/vote.jsp

说明

在投票详情页中投票

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
activityID 活动id string ""
optionID 选项id string ""
deviceID 设备ID string "" 设备id

返回

{
  "status":0,
  "msg":"投票成功"
}

返回参数说明

参数名 参数含义 参数名参数含意

4.自媒体


4.1自媒体列表

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

说明

读取所有自媒体列表

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo页数int1
pageSize页面大小int40

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 40,
  "total": 100,
  "data":[
    {
      "authorID":"作者ID",
      "authorName":"作者名称",
      "authorWXID":"作者微信公众号",
      "authorUrl":"作者头像",
      "desc":"简介",
    },
    ......
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
authorName 作者名称 authorID 作者ID


4.2自媒体主页


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

说明

获取指定自媒体的主页信息

缓存时间

15分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
authorID自媒体IDint
pageNo页数int1
pageSize页面大小int20

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":{
    "author":{
        "authorID":"作者ID",
        "authorName":"作者名称",
        "authorWXID":"作者微信公众号",
        "authorImage":"作者头像",
        "desc":"简介",
        "supportCount":"点赞数",
        "opposeCount":"反对数"
    },
    "articleList":[
      { 
        "specialID":"所属一级专题ID",
        "specialName":"所属一级专题名称",
        "authorID":"作者ID",
        "authorName":"作者名称",
        "authorImage":"作者头像",
        "articleID":"文章id"
        "imageUrl":"文章图片",
        "title":"文章标题",
      },
      ......
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
authorName 作者名称 authorID 作者ID


5.个人中心


5.1修改昵称

开发环境: http://dev15.pclady.com.cn:8004/app/syncNickName.jsp
线上环境: http://choice.pclady.com.cn/app/syncNickName.jsp

说明

修改昵称

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
nickName 昵称string""

返回

{
  "status":0,
  "msg":"请求成功",
}

返回参数说明

参数名 参数含义 参数名参数含意
status 返回状态


5.2修改头像

url: http://upc.pconline.com.cn/upload_head.jsp

说明

修改头像

缓存时间

0分钟

提交方式

POST

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
form-data 二进制图片数据

返回

{
  "status":0,
  "msg":"请求成功"
}

返回参数说明

参数名 参数含义 参数名参数含意
status 返回状态


5.3我的收藏

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

说明

获取我的收藏列表,分为文章与活动两种

缓存时间

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo 页码 int 1
pageSize 每页行数 int 20
type 类型 int 0:文章 1:活动

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[
    { 
      "specialID":"专题ID",
      "specialName":"专题名称",
      "authorID":"作者ID",
      "authorName":"作者名称",
      "authorUrl":"作者头像",
      "articleID":"文章id"
      "imageUrl":"文章图片",
      "title":"文章标题"
    },
    ......
  ]
}

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[
    { 
      "activityID":"活动ID",
      "activityName":"活动名称",
      "activityType":"活动类型",
      "userCount":"参与用户人数",
      "date":"活动发布日期"
      "imageUrl":"活动图片",
      "desc":"活动简介前80字"
    },
    ......
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
status 返回状态


5.4我的订阅(专题)

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

说明

获取用户已订阅的专题列表

缓存时间

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo 页码 int 1
pageSize 每页行数 int 20

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[
      {
        "specialID":"专题ID",
        "specialName":"专题名称",
        "introduceText":"专题简介文本",
        "imageUrl":"专题图片",
        "articleCount":"文章篇数",
        "followCount":"关注人数"
      },
      ......
    ]
}

返回参数说明

参数名 参数含义 参数名参数含意
status 返回状态


5.5我的订阅(更新)

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

说明

获取我的订阅中自订阅时间起更新的所有文章

缓存时间

提交方式

GET

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo 页码 int 1
pageSize 每页行数 int 20

返回

{
  "status":0,
  "msg":"请求成功",
  "pageNo": 1, 
  "pageSize": 20,
  "total": 100,
  "data":[
    { 
      "specialID":"专题ID",
      "specialName":"专题名称",
      "authorID":"作者ID",
      "authorName":"作者名称",
      "authorUrl":"作者头像",
      "articleID":"文章id"
      "imageUrl":"文章图片",
      "title":"文章标题",
      "datetime":"YYYY-MM-DD HH:mm:ss",
      "firstSpecialID":"所属一级专题ID",
      "firstSpecialName":"所属一级专题名称"
    },
    ......
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
datetime 文章的更新时间


5.6我的订阅中文章更新数

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

说明

获取我的订阅中所有文章更新数

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

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

返回

{
  "status":0,
  "msg":"请求成功",
  "newArticleCount":"11"
}

返回参数说明

参数名 参数含义 参数名参数含意
newArticleCount 已更新的文章数量


5.7获取用户信息

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

说明

获取用户信息

缓存时间

0分钟

提交方式

GET

是否登录

数据来源

编辑后台

参数

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

返回

{
  "status":0,
  "msg":"请求成功",
  "data":{
   "nickName":"昵称"(mrobot转义)
}
}

返回参数说明

参数名 参数含义 参数名参数含意
nickName 用户昵称


6.其它


6.1启动上报

开发环境: http://dev15.pclady.com.cn:8004/app/reportStartUp.jsp
线上环境: http://choice.pclady.com.cn/app/reportStartUp.jsp

说明

当天用户第一次启动时,需要上报一次。便于判断活跃度

缓存时间

0

提交方式

POST

是否登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
terminal 客户端类型 int "" 1:iOS,2:Android
token 魔方推送apns token String "" iOS为魔方的token,安卓为deviceId

返回

{
  "status":0,
  "msg":"请求成功"
}

返回参数说明

参数名 参数含义 参数名参数含意


6.2新增用户

开发环境: http://dev15.pclady.com.cn:8004/app/addUser.jsp
线上环境: http://choice.pclady.com.cn/app/addUser.jsp

说明

注册成功后,通知平台添加用户和积分

缓存时间

0

提交方式

POST

是否需要登录

数据来源

编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
r时间截String""
signMD5加密串String""
type类型String""1:qq,2:微信,3:新浪
nickName昵称String""

返回

{
  status:0,
  msg:”请求成功”
}