@lina 2016-07-09T04:05:31.000000Z 字数 8232 阅读 423

桃瓣美妆1.0 API文档

桃瓣 api iOS Android wechat

一、通用约定

1.1 通用接口

1.1.1 API Base Url

【线上base url】http://api-beauty.51eshijia.com/api/v1/
【测试base url】http://api-beauty.51yishijia.com/api/v1/

1.1.2 H5 Url

【线上h5页面】http://m-beauty.51eshijia.com/
【测试h5页面】http://m-beauty.51yishijia.com/

1.1.3 图片资源 Base Url

接口下发的所有图片资源都是相对路径，都需要拼接base
【线上base url】http://beauty-images.51eshijia.com/
【测试base url】http://beauty-images.51yishijia.com/

1.1.4 上传图片

通用上传文件服务

请求URL

POST
/upload

请求参数

token

file : 文件

响应

{
    errorCode: 0,
    data: {
        url: 'http://xxx'
    }
}

url : [string] 文件的访问URL

1.2 通用请求字段

1.2.1 鉴权字段

token : [string] 登录后获取的 token 信息
：时效为1年，过期提示“请重新登录”，弹出登录页面

1.2.2 用户身份字段

header中的User-Agent
iOS:com.cheyu.taoban/1.0.0 (iPhone OS 9.3.1, iPhone6s)
Android:com.cheyu.taoban/1.0.0 (Android OS 4.3.1, YQ601)

1.3 通用响应字段

1.3.1 状态字段

errorCode: [int] 服务器状态码，0 为正常状态，异常状态待定。

errorMessage：[string] 错误信息，但 errorCode 不为 0 时返回

1.3.2 数据字段

data: [object] 数据字段，所有响应数据都在此字段中

list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

pageInfo: [object] 分页信息，当返回数组数据时会携带该字段

currentPage: [int] 当前页码

totalPage: [int] 总页数

pageSize: [int] 每页数量：本项目常用pageSize==10

示例

{
    errorCode: 0,
    data: {
        key: value,
        list: [{
            key: value
        }],
        pageInfo {
        }
    }
}

二、通用数据结构

2.1 常量

2.1.1 客服电话

010-57274768

2.1.2 推送和广告跳转方式

jumpMode: [int]
0:不跳转
1:跳转到link链接
2:跳转到美妆详情

2.1.3 美妆分类

infoType:[int]
1:教程类，
2:活动类，对应tab中的专题

2.1.4 请求美妆列表类型

infoListType:[int]
1:首页推荐列表
2:搜索关键字列表
3:搜索特定标签列表
4:最新列表
5:精选合集列表
6:第一个课程合集的列表

2.1.5 美妆标签列表类型

tagListType:[int]
1:tab中分类的tag列表
2:搜索中热门标签

2.1.6 美妆资讯来源

infoFrom:[int]
1：首页-推荐
2：首页-最新
3：首页-精选
4：Banner推荐
5：专题
6：标签搜索
7：自输入搜索
8：收藏

2.2 基础信息结构

2.2.1 美妆相关

2.2.1.1 美妆资讯（列表+详情）

{
    id: 1,
    title: '专业测评宝马5系',
    shortTitle:'宝马'
    coverUrl:'/1.png'
    contentH5:'<html>xxxxxx',
    videoUrl:'http://xxxxxx',
    viewCount: 1000,
    commentCount:1000,
    publicTime:14390009,
    publisher:'@发表用户',
    product:['@美妆产品'],
    tagArray:['@标签'],
    infoType:1
}

id: [int] 资讯ID

title: [string] 标题

shortTitle: [string] 短标题，用于展示于图片上

coverUrl: [string] 封面图片

contentH5: [string] 内容Html页面【列表不下发，详情下发】

videoUrl: [string] 视频地址

viewCount: [int] 浏览量

commentCount: [int] 评论数

publicTime: [int] 发表时间，时间戳

publisher: [object]发表用户，'@用户'

product:[array]'@美妆产品'

tagArray:[array]'@标签'：最多展示2个，每一个标签的长度为2~4个字

infoType:[int]'@美妆分类'

2.2.1.2 美妆产品

{
    id: 1,
    title: '专业测评宝马5系',
    interestCount: 1000,
    thumbnail:'/1.png',
    marketPrice:99.0,
}

id: [int] 资讯ID

title: [string] 标题

interestCount: [int] 感兴趣人数

thumbnail: [string] 缩略图地址

marketPrice: [float] 市场价格

2.2.1.3 标签（列表中的标签+搜索中标签+分类）

{
    id: 1,
    name: '标签名称',
    pic: '1.png'
}

id: [int] ID

name: [string] 标签名称

pic: [string] 标签图片

2.2.1.4 “精选合集”

{
    id: 1,
    pic: '1.png',
    title:'xxxxxxx'
}

id: [int] 专题ID

pic: [string] 精选合集图片

title:[string] 精选标题

2.2.2 用户

{
    id: 123,
    nickname: 'xiaobaitu',
    avatar: '/img1.imgtn.bdimg.com/it/u=1477579747,1739345058&fm=23&gp=0.jpg',
    cell: '15801379137',
}

id: [int] 用户ID

nickname: [string] 用户昵称

avatar: [string] 头像图片地址

cell: [string] 用户手机号

2.2.3 评论

{
    id: 1,
    user: '@用户信息',
    content:'这次体验非常好，非常好非常好非常好非常好非常好非常好',
    publicTime:14390009
}

id: [int] 评论ID

user: [object] 用户信息

content: [string] 评论内容

publicTime: [int] 评论时间，时间戳

2.2.4 广告

{
    id:1
    pic: 'https://ss0.bdstatic.com/70cFuHSh_Q1YnxGkpoWK1HF6hhy/it/u=1722966551,3293303547&fm=116&gp=0.jpg',
    link: '#abc',
    title: '试驾特斯拉Model S P85D',
    desc: '来自未来的车',
    jumpMode:'@广告跳转方式',
    infoId:'@资讯Id'
}

id: [int] ID

pic : [string] 图片地址

link: [string] 链接

title: [string] 广告标题

desc: [string] 广告描述

jumpMode:[int]跳转方式方式

infoId:[int]jumpMode==2的时候，请求资讯详情或者活动详情

2.4.5 版本信息

{
    version:'1.0.0',
    url: 'http://www.baidu.com',
    description: '小米市场',
    from:'iOS_91'
}

version: [string] 版本号

url: [string] 升级地址

description: [string] 版本描述

from: [string] 渠道值

三、API 接口

3.1 用户信息

3.1.1 获取验证码

请求URL

POST
/login/verifycode

请求参数

phoneNumber: [string]接收验证码的手机号

响应

{
    errorCode: 0,
    data: {
    }
}

3.1.2 登录

请求URL

POST
/login

请求参数

phoneNumber: 手机号

verifyCode: 验证码

deviceId: 设备 ID

响应

{
    errorCode: 0,
    data: {
        token: '19201931210e'
    }
}

token : [string] 登录成功后的token，后续数据接口均需携带该参数

3.1.3 登出

请求URL

POST
/loginout

请求参数

token

响应

{
    errorCode: 0,
    data: {
    }
}

3.1.4 获取个人资料

请求URL

POST
/me

请求参数

token

响应

{
    errorCode: 0,
    data: {
        '@用户信息'
    }
}

3.1.5 更改个人资料

请求URL

POST
/me/update

请求参数

token

avatar : [string]图片url

nickname : [string]用户昵称

响应

{
    errorCode: 0,
    data: {
        '@用户信息'
    }
}

3.1.6 个人中心反馈

请求URL

POST
/feedback

请求参数

token

content : 反馈内容

响应

{
    errorCode: 0,
    data: {
    }
}

3.2 美妆相关

3.2.1 “美妆资讯”列表(首页+搜索+点击分类)

接口说明

本接口可以请求到以下三种情况的美妆列表
==1:首页推荐列表
==2:搜索关键字列表，上传keyword
==3:搜索特定标签列表，上传tagId
==4:最新列表
==5:精选合集列表，上传subjectId
==6:第一个合集的课程列表

请求URL

POST
/list

请求参数

`` : [int] 列表类型【必填】

keyword:[string]搜索关键词，==2为必填

tagId:[int]搜索标签，==3为必填

subjectId:[int]专题ID，==5为必填

pageNum: [int]页码【必填】

pageSize:[int]页长【必填】

token:[string]【选填】登录后为必填

响应

{
    errorCode: 0,
    data: {
        list: [
            '@美妆资讯'
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

3.2.2 “活动资讯”列表

接口说明

获取tab_index==1的列表，list只展示一张cover，其余信息在详情展示，点击列表进入“美妆资讯”详情

请求URL

POST
/column

请求参数

pageNum: [int]页码【必填】

pageSize:[int]页长【必填】

响应

{
    errorCode: 0,
    data: {
        list: [
            '@美妆资讯'
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

3.2.3 “美妆资讯”详情

接口说明

详情接口下发contentH5字段，需要增加infoFrom参数，显示来源

请求URL

POST
/detail?infoFrom=1

请求参数

infoId: [int]资讯ID【必填】

token:[string]【选填】登录后为必填

响应

{
    errorCode: 0,
    data: {
            '@美妆资讯'
    }
}

3.2.4 “精选合集”（subject list）

接口说明

首页上，顶部“精选”页面，点击列表，进入美妆列表，再次点击，才进入详情

请求URL

POST
/subject/list

请求参数

pageNum: [int]页码【必填】

pageSize:[int]页长【必填】

响应

{
    errorCode: 0,
    data: {
            list:['@精选合集'],
            pageInfo:[
            '@分页字段'
        ]
    }
}

3.2.5 “标签”列表

接口说明

tagListType==1,请求tab中分类的tag列表
tagListType==2,搜索中的热门标签列表

请求URL

POST
/tag

请求参数

tagListType:[int] '@美妆标签列表类型'【必填】

响应

{
    errorCode: 0,
    data: {
            list : ['@标签'],
    }
}

3.2.6 “猜你喜欢”列表

接口说明

请求URL

POST
/love

请求参数

响应

{
    errorCode: 0,
    data: {
            list : ['@美妆资讯']
    }
}

3.2.7 “推荐视频”列表

接口说明
按照视频播放次数排名列表，取12个

请求URL

POST
/recom

请求参数

响应

{
    errorCode: 0,
    data: {
            list : ['@美妆资讯']
    }
}

3.2.8 “精选合集”详情

接口说明

请求URL

POST
/subject/detail

请求参数

id: [int] 【必填】

响应

{
    errorCode: 0,
    data: {
             '@精选合集'
    }
}

3.2.9 “标签”详情

接口说明

请求URL

POST
/tag/detail

请求参数

id: [int] 标签id【必填】

响应

{
    errorCode: 0,
    data: {
             '@标签'
    }
}

3.3 评论相关

3.3.1 评论列表

请求URL

POST
/comment
请求参数

beautyId : [int] 美妆资讯ID【必填】

pageNum: [int]【必填】

pageSize:[int]【必填】

响应

{
    errorCode: 0,
    data: {
        list: [
                '@评论'
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

3.3.2 发表评论

请求URL

POST
/comment/send

请求参数

beautyId : [int] 美妆资讯ID【必填】

content : [string] 评论内容【必填】

token:身份认证【必填】

响应

{
    errorCode: 0,
    data: {
        '@评论'
    }
}

3.4 广告

请求URL

POST
/banner

请求参数

无

响应

{
    errorCode: 0,
    data: {
        list: [
           @'广告'
        ]
    }
}

3.8 收藏

3.8.1 收藏列表

请求URL

POST
/user/collects
请求参数

token:身份认证【必填】

响应

{
    errorCode: 0,
    data: {
        list: [
            '@美妆资讯'
        ],
        pageInfo:[
            '@分页字段'
        ]
    }
}

3.8.2 收藏/取消收藏

请求URL

POST
/user/collect/change
请求参数

token:身份认证【必填】

infoId:资讯id【必填】

collected:1收藏 0取消收藏【必填】

响应

{
    errorCode: 0,
    data: {
    }
}

3.8.3 查询收藏状态

请求URL

POST
/user/collect/check
请求参数

token:身份认证【必填】

infoId:资讯id【必填】

响应

{
    errorCode: 0,
    data: {
        collected:0
    }
}

collected:1收藏 0未收藏

3.9 推送

3.9.1 开启推送

请求URL

POST
/push
请求参数

user_id : [string] 推送用户ID 必填

channel_id : [string] 设备ID 必填

token : [string] 用户标识 [选填]

device_type : [int] 设备类型 1:iOS,2:andriod 必填

响应

{
    errorCode: 0,
    data: {
    }
}

3.9.2 取消推送

请求URL

POST
/push/cancel
请求参数

user_id : [string] 推送用户ID 必填

响应

{
    errorCode: 0,
    data: {
    }
}

3.9.3 推送内容

aps:{
    alert:"test",
    badge:1,
    jumpMode:1,
    infoId:12233,
    link:'http://xxxxxxx',
    title:'xxxxx'
}

for android:
*title:固定：“桃瓣美妆”
*content:alert字段
jumpMode: [int] 跳转方式
infoId: [string]jumpMode==2，通过infoId，进入资讯详情。
link: [string]jumpMode == 1，link不为空进入H5页面。
title: [string]jumpMode == 1，进入H5页面是topbar标题。

3.10 升级

请求URL

POST
/updateVersion

请求参数

from:渠道值（同“四、渠道号“）

响应

{
    errorCode: 0,
    data: {
        '@版本信息'
    }
}

四、其他URL

4.1 隐私协议

H5 URL

http://m-beauty.51eshijia.com/policy/privacy

4.2 分享协议

H5 URL

1、分享地址：
【线上】http://m-beauty.51eshijia.com/share/资讯ID
【测试】http://m-beauty.51eshijia.com/share/资讯ID
【说明】本地需要中转后，跳转到微信端详情页面（中转用户统计）
标题：桃瓣美妆：+ $资讯标题
摘要：分享来自【桃瓣美妆】，你的贴身美妆顾问，帮你从女生变女神。

4.3 App下载地址

H5 URL

ALL:http://m-beauty.che-yu.cn/app
安卓下载地址：http://m-beauty.che-yu.cn/android-taoban.apk

4.4 关于页面（展示版本号）

文案：
易试驾是北京车语互联科技有限公司旗下一款试驾预约APP，该产品秉承“让试驾变得更容易”的理念，通过线上预约，线下体验的方式，为买车换车用户提供购车前的试驾预约服务。

H5 URL

【线上地址】http://m-beauty.51eshijia.com/about?from=app

请求方式：
Get

请求参数
type: 1:正式版本 2:build版本 3: alpha版本
正式版本H5页面显示Version+版本号
build版本H5页面显示Build+版本号
alpha版本H5页面显示Alpha+版本号

type:版本种类【必填】

versionNum:版本号【必填】

四、渠道号

【安卓市场】

描述	from
360手机助手	Android_360
安卓市场	Android_market
豌豆荚	Android_wandoujia
百度手机助手	Android_baidu
应用宝	Android_app
小米商店	Android_mi
安智市场	Android_anzhi
乐商店	Android_leshop
华为应用市场	Android_huawei
魅族应用中心	Android_meizu
oppp软件商店	Android_oppp
UC	Android_uc
友盟	Android_umeng
官网	Android_officalwebsite
安贝市场	Android_anbei
安粉网	Android_anfen
安卓之家	Android_home
安卓园	Android_park
易用汇	Android_easy
搜狗手机助手	Android_sogo
移动应用商场	Android_mobile
机锋市场	Android_jifeng
N多网	Android_n
乐视应用商店	Android_leshi
爱奇艺应用商店	Android_aiqiyi
应用贝	Android_yingyongbei
三星应用商店	Android_sumsung
联通沃商店	Android_wo
应用汇	Android_yingyonghui
木蚂蚁	Android_ant
冒泡堂	Android_bubble
海信应用商店	Android_hisense

【iOS苹果】

描述	from
苹果商店	App Store
PP助手	iOS_PP
同步推	iOS_tongbutui
快用苹果助手	iOS_kuaiyong
苹果园	iOS_pingguoyuan
91助手iOS	iOS_91
官网	iOS_officalwebsite

五、统计点

事件（统计点）	event_id	attribute	英文名称	中文名称
点击首页”搜索“	TB_0001	“event”=“home_search”	home_search	首页搜索
点击首页”最新“	TB_0001	“event”=“home_new”	home_new	首页最新
点击首页”精选“	TB_0001	“event”=“home_selected”	home_selected	首页精选
点击tab”专题“	TB_0002	“event”=“tab_subject”	tab_subject	tab”专题“
点击tab”分类“	TB_0003	“event”=“tab_category”	tab_category	tab”分类“
点击tab”我的“	TB_0004	“event”=“tab_my”	tab_my	tab”我的“
点击“收藏”	TB_0005		collect_button	收藏按钮
点击“登录返回按钮”	TB_0006		login_back	登录跳出
点击“分享按钮”	TB_0007		share_button	分享

桃瓣美妆1.0 API文档

一、通用约定

1.1 通用接口

1.1.1 API Base Url

1.1.2 H5 Url

1.1.3 图片资源 Base Url

1.1.4 上传图片

1.2 通用请求字段

1.2.1 鉴权字段

1.2.2 用户身份字段

1.3 通用响应字段

1.3.1 状态字段

1.3.2 数据字段

1.3.3 分页字段

二、通用数据结构

2.1 常量

2.1.1 客服电话

2.1.2 推送和广告跳转方式

2.1.3 美妆分类

2.1.4 请求美妆列表类型

2.1.5 美妆标签列表类型

2.1.6 美妆资讯来源

2.2 基础信息结构

2.2.1 美妆相关

2.2.1.1 美妆资讯（列表+详情）

2.2.1.2 美妆产品

2.2.1.3 标签（列表中的标签+搜索中标签+分类）

2.2.1.4 “精选合集”

2.2.2 用户

2.2.3 评论

2.2.4 广告

2.4.5 版本信息

三、API 接口

3.1 用户信息

3.1.1 获取验证码

3.1.2 登录

3.1.3 登出

3.1.4 获取个人资料

3.1.5 更改个人资料

3.1.6 个人中心反馈

3.2 美妆相关

3.2.1 “美妆资讯”列表(首页+搜索+点击分类)

3.2.2 “活动资讯”列表

3.2.3 “美妆资讯”详情

3.2.4 “精选合集”（subject list）

3.2.5 “标签”列表

3.2.6 “猜你喜欢”列表

3.2.7 “推荐视频”列表

3.2.8 “精选合集”详情

3.2.9 “标签”详情

3.3 评论相关

3.3.1 评论列表

3.3.2 发表评论

3.4 广告

3.4.1 首页 Banner

3.8 收藏

3.8.1 收藏列表

3.8.2 收藏/取消收藏

3.8.3 查询收藏状态

3.9 推送

3.9.1 开启推送

3.9.2 取消推送

3.9.3 推送内容

3.10 升级

四、其他URL

4.1 隐私协议

4.2 分享协议

4.3 App下载地址

4.4 关于页面（展示版本号）

四、渠道号

五、统计点

内容目录