wiki:yimei1.0.0_api

Version 11 (modified by caomenglin, 11 years ago) (diff)

--

Table of Contents

  1. 引导页项目列表(CMS)
  2. 焦点图(CMS)
  3. 特色展示(CMS)
  4. 活动专场(CMS)
  5. 城市列表(CMS)
  6. 新增用户
  7. 获取用户资料
  8. 完善用户资料
  9. 提交感兴趣的项目
  10. 首页数据接口
  11. 获取专场列表
  12. 获取专场详情
  13. 获取优惠活动列表
  14. 获取活动详情(web页)
  15. 提交订单
  16. 获取用户订单
  17. 获取订单详情
  18. 医院主页（web）
  19. 获取医院详细信息(web页)
  20. 获取医生列表
  21. 医生主页
  22. 获取医生详细信息(web页)
  23. 获取部位和项目列表
  24. 获取案例列表
  25. 获取晒单/案例详细信息(web页)
  26. 获取用户积分
  27. 获取历史积分
  28. 签到
  29. 收藏/取消收藏
  30. 是否收藏
  31. 获取收藏列表
  32. 获取标签列表
  33. 发表晒单
  34. 获取项目介绍信息 (web页)
  35. 意见反馈 /版本更新
  36. 登录/注册/重置密码/修改密码

医美1.0.0接口文档

引导页项目列表(CMS)

getGuidProjectList

说明

获取引导页中的项目, ID对应整形库中的，但名称可能不一样。

提交方式

GET

数据来源

CMS

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  data:[{
    typeID:"1",
    name:”眼部”
   }]
}

焦点图(CMS)

getFocusList

说明

获取焦点图,最多5张

提交方式

GET

数据来源

CMS

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  data:[{
      type:1,
      imageUrl:” http://img.pconline.com.cn/7.jpg”,
      url:”” ,
      contentID:”14324”
    }]
}

返回参数说明

参数名 参数含义 参数名参数含意
type 1:活动详情页，2：专场详情页，3，案例详情页，4：项目详情页，5：外链URL，6：活动列表，7：专场列表，8：案例列表 contentID 文章类的ID
url 如果类型为5，需要URL

特色展示(CMS)

getShowList

说明

获取特色展示,2条

提交方式

GET

数据来源

CMS

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  data: [{
      showTitle:”一元秒杀”,
      showDesc:”有积分就是任性”,
      imageUrl:” http://img.pconline.com.cn/7.jpg”,
      url:””,
      type:1,
      contentID:”14324”
}]
}

返回参数说明

参数名 参数含义 参数名参数含意
type 1:活动详情页，2：专场详情页，3，案例详情页，4：项目详情页，5：外链URL，6：活动列表，7：专场列表，8：案例列表 contentID 文章类的ID
url 如果类型为5，需要URL showDesc 描述信息

活动专场(CMS)

getAcitivitiesSpecialList

说明

获取活动专场,3条

提交方式

GET

数据来源

CMS

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  data: [{
      title:”新年美肤专场，水嫩肌肤换出来”,
      imageUrl:”http://img.pconline.com.cn/7.jpg”,
      specialID:”14242”
    }]
}

返回参数说明

参数名 参数含义
specialID 专场ID

城市列表(CMS)

getCityList

说明

获取活动专场,3条

提交方式

GET

数据来源

CMS

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  data: [“北京”,”上海”,”广州”]
}

新增用户

addUser

说明

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

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是

返回 

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

获取用户资料

getUsuerInfo

说明

获取用户的资料

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是

返回 

{
  status:0,
  msg:”请求成功”,
  data:{ 
    phoneNum:”13588888888”,
    username:”昵称”,
    percent:50,
    headUrl:"",
    sex:"男",
    birthday:"1990-09-21",
    age:70,
    city:"广东广州",
    useProject:" 1, 2",
    likeProject:" 1, 2",
    signature:"个性签名", 
    noUse:2,
    score:123
    }
}

返回参数说明

参数名 参数含义 参数名参数含意
percent 资料完善的百分比 age 年龄段
useProject 整过的项目 likeProject 喜欢的项目
noUse 未消费的数量 score 用户总积分

完善用户资料

updateUserInfo

说明

完善用户资料

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id 用户IDString""是
nickname 昵称String""否
sex 性别String""否
birthday 生日String""否
age 年龄段int""否
city 城市String""否
likeProject 感兴趣的项目String""否
useProject 整过的项目String""否
signature 个性签名String""否

返回 

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

提交感兴趣的项目

addLikeProject

说明

用于提交引导页中感兴趣的项目，卸载APP后再次提交时，覆盖添加

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
common_session_id用户标识String""是
age年龄段String""否
project项目列表String""否列表

返回 

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

首页数据接口

index

说明

获取首页数据，包括焦点图（最多5条）、特色展示（2条）、活动专场（3条）、猜你喜欢（3条）、推荐案例（3条）

提交方式

POST

数据来源

焦点图：CMS、特色展示：CMS、活动专场：CMS、猜你喜欢：整形库编辑后台、推荐案例：整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
city城市String""否
project感兴趣的项目String""否
age年龄段int""否

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    listFocus:[{
      type:1,
      imageUrl:” http://img.pconline.com.cn/7.jpg”,
      url:”” ,
      contentID:”14324”
    }],
    show:[{
      showTitle:”一元秒杀”,
      showDesc:”有积分就是任性”,
      imageUrl:” http://img.pconline.com.cn/7.jpg”,
      url:””,
      type:1,
      contentID:”14324”
    }],
    activities:[{
      title:”新年美肤专场，水嫩肌肤换出来”,
      imageUrl:”http://img.pconline.com.cn/7.jpg”,
      specialID:”14242”
    }],
    guessYouLike:[{
      likeID:”24234”,
      title:”标题”,
      typeName:”限量30份”,
      imageUrl”http://img.pconline.com.cn/7.jpg”,
      price:999,
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:”2015-05-01”, 
      buyTotal:100,
      isEnd:1 
    }],
    example:[{
      title:”变美过程全记录”,
      desc:”就是这样变美的”,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:”1321”
    }]
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
listFocus 焦点图 show 特色展示
activities 活动专场 guessYouLike 猜你喜欢，字段说明参考活动列表
example 案例，字段说明参考案例列表

获取专场列表

getSpecialList

说明

获取专场列表

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{
    title:"陈柯",
    specialID:””, 
    city:”广州,深圳,北京”, 
    discount:””,
    buyTotal:12,
    imageUrl:""
   }]
}

返回参数说明

参数名 参数含义 参数名参数含意
discount 折扣 buyTotal 抢购人数

获取专场详情

getSpecial

说明

获取专场列表

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int4是
specialID 专场IDString””是

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data: [{ 
    activitiesID:””, 
    title:””, 
    typeName:””, 
    imageUrl””, 
    price:999, 
    discountPrice:1,
    businessName:”深圳广济医疗美容医院”, 
    doctor:”陈柯”, 
    beginTime:””, 
    buyTotal:100, 
    isEnd:1
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
typeName 角标名称 price 单价
discountPrice 优惠价 buyTotal 抢购人数

获取优惠活动列表

getDiscountActivitiesList

说明

获取优惠活动列表

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo页数int1是
pageSize页面大小int10是
likeProject项目String""否感兴趣的项目
project项目String""否项目ID，过滤的项目
age年龄段int""否
city城市String""否过滤时用到的城市
locationCity城市String""否用户所在城市
specialID专场String""否专场ID
order排序String"1"否排序规则1：销量，2：价格，默认不传
businessID商家String""否从医院进入更多界面时需要根据商家ID请求
buyOther购买了该活动的用户还购买了其它的。String""否传1表示需要过滤

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{ 
    activitiesID:””, 
    title:””, 
    typeName:””, 
    imageUrl””, 
    price:999, 
    discountPrice:1,
    businessName:”深圳广济医疗美容医院”, 
    doctor:”陈柯”, 
    beginTime:””, 
    buyTotal:100, 
    state:1
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
typeName 角标名称 price 单价
discountPrice 优惠价 buyTotal 已抢购数量
state 状态:1：进行中，2：未开始，3：已结束 beginTime 开始抢购时间

获取活动详情(web页)

getActivitesInfo

说明

获取活动详情

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
activitiesID活动String""是

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    businessID:"商家ID",
    needScore:200,
    totalScore:1000, 
    canUseScore:100, 
    frontMoney:300,
canBuyTotal:1,
    surplusTotal:3,
    html:""
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
needScore 所需积分 totalScore 用户总积分
frontMoney 定金 canBuyTotal 限购数量
canUseScore本次活动可以使用的积分 surplusTotal 剩余数量

提交订单

createOrder

说明

抢购后生成订单

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是
activitiesID活动String""是
total购买数量 int ""是
price单价 int ""是
phoneNum手机号String""是
needScore所需积分String""否
useScore兑换的积分String""是
orderID定单号：从订单详情页支付时需要传ID来修改消费的积分 String ""否

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    orderID:"12424234234",
    score:"100",
    password:"123456,123124,432423"

  }
}

返回参数说明

参数名 参数含义 参数名参数含意
score 奖励的积分 password 消费密码

获取用户订单

getUserOrderList

说明

获取我的订单

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int4是
common_session_id 用户标识String""是
orderType 订单类型1:全部，2：未消费，3：已消费，4：待付款int""是

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{
    orderID:"123442342",
    imageUrl:””, 
    title:”订单标题”, 
    priceTotal:600,
    total:2,
    failureTime:”2015-04-04”, 
    endTime:”2015-04-04”, 
    useTime:”2015-04-04”, 
    delayTime:”2015-04-04”, 
    orderTime:”2015-04-04”,
    state:1,
    showOrderID:"23423432",
    activitiesID:’111111’
   }]
}

返回参数说明

参数名 参数含义 参数名参数含意
priceTotal总价failureTime失效时间，未付款时用到
useTime 消费时间endTime 活动结束时间
delayTime消费最后期限state1：待付款，2：未消费，3：已消费，4：已过期，5：已失效,6:已晒单
showOrderID晒单ID orderTime 下单时间

获取订单详情

getOrderInfo

说明

获取订单详情

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int4是
orderID 订单int""是

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    phoneNum:"13588888888",
    userTotalScore:1000,
    canUseScore:300,
    pwd:[{
       password:”111111”,
       state:1,
       showPhotoID:””
      }]
   }
}

返回参数说明

参数名 参数含义 参数名参数含意
canUseScore 本交活动可以消费的积分，去支付时需要用到 userTotalScore 用户总积分
password 消费密码 showPhotoID 晒单ID

医院主页（web）

getBusiness

说明

获取商家信息

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
businessID商家 String ""是

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    name:”商家名称”, 
    isVip:1, 
    authentication:1, 
    grading:"公立三级医院美容科室", 
    desc:"医院信息", 
    address:"广州",
    workTime:”10:00-21:00”, 
    project:[{ 
      total:20, 
      list:[{
    typeID:"1",
    name:”眼部”
   }]
    }],
  example:{
    total:20,
    list:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }]
  },
  activities:{
    total:20,
    list:[{ 
      activitiesID:””, 
      title:””, 
      typeName:””, 
      imageUrl””, 
      price:999, 
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:””, 
      buyTotal:100, 
      isEnd:1
    }]},
doctor:{
    total:20,
    list:[{ 
      doctorID:””, 
      imageUrl:””, 
      job:””, 
      name””
    }]}
  }
}

返回参数说明

参数名 参数含义 参数名参数含意
isVip 是否为VIP authentication 是否认证
grading 医院等级名称 workTime 营业时间

获取医院详细信息(web页)

getBusinessInfo

说明

获取医院详细信息

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
businessID 活动String""是

返回 

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

获取医生列表

getDoctorList

说明

根据医院信息获取医生列表

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int3是
businessID医院String""是

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{
    name:"陈柯",
    doctorID:””, 
    imageUrl:””, 
    job:””
   }]
}

返回参数说明

参数名 参数含义
job 职位名称

医生主页

getDoctor

说明

获取商家信息

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
doctorID医生 String ""是

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    desc:”医生详情”, 
  example:{
    total:20,
    list:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }] }
  }
}

获取医生详细信息(web页)

getDoctorInfo

说明

获取医生详细信息

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
doctorID 医生IDString""是

返回 

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

获取部位和项目列表

getProjectList

说明

获取部位，项目

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  total:11,
  data:[{
    typeID:"1",
    name:”一级部位”,
    item:[{
      typeID:”101”,
      name:”二级部位”
      item:[{
        typeID:”201”,
        name:”项目名称”
      }]
    }]
   }]
}

获取案例列表

getExampleList

说明

获取案例列表

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须 说明
pageNo页数int1是
pageSize页面大小int3是
likeProject项目String""否
positionID部位IDString""否
projectID项目IDString""否
doctorID医生IDString""否医生主页中会根据医生来获取案例
businessID医院IDString""否医院主页中会根据医院来获取案例

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:[{ 
    exampleID:””, 
    title:””, 
    desc:””, 
    imageUrl””, 
    username:"小美", 
    time:"2015-01-24",
    essence:1, 
    publicationPhoto:1 
    beginTime:””
    }
  ]
}

返回参数说明

参数名 参数含义 参数名参数含意
essence 是否精华：1：是，0：否 publicationPhoto 是否晒单：1：是，0：否

获取晒单/案例详细信息(web页)

getExampleInfo

说明

获取案例详情信息，返回的标签点击后要做处理

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
exampleID案例IDString""是

返回 

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

获取用户积分

getUserScore

说明

获取用户积分

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id 用户标识String""是

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    scoreTotal:"105",
days:5, 
    canGetScore:5,
    monthIn:110,
    monthOut:50
   }
}

返回参数说明

参数名 参数含义 参数名参数含意
scoreTotal 用户总积分 days 连续签到天数
monthIn 近一个月进账 monthOut 近一个月支出
canGetScore今天可领积分

获取历史积分

getUserScoreList

说明

获取用户历史积分

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int4是
common_session_id 用户标识String""是

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    content:"参加活动",
    time:”2015-04-15”,
    type:”1” ,
    score:200
   }
}

返回参数说明

参数名 参数含义 参数名参数含意
content 积分详情 score 消费积分
type 1：进账，2：支出 time 消费时间

签到

getMyScore

说明

签到

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id 用户标识String""是

返回 

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

返回参数说明

参数名 参数含义
score 用户总积分

收藏/取消收藏

collectForApp

说明

用于添加收藏和取消收藏

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是
activitiesID活动 String ""是
type类型：1：活动，2：案例 int ""是
operation操作：1：收藏，2：取消收藏 int ""是

返回 

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

是否收藏

hasCollectForApp

说明

判断活动是否已经收藏

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是
activitiesID活动 String ""是
type类型： 1：活动，2：案例 int ""是

返回 

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

获取收藏列表

getCollectList

说明

根据类型获取收藏列表

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int3是
common_session_id用户标识String""是
type类型：1：活动，2：案例 int ""是

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    activitiesList:[{ 
      activitiesID:””, 
      title:””, 
      typeName:””, 
      imageUrl””, 
      price:999, 
      discountPrice:1,
      businessName:”深圳广济医疗美容医院”, 
      doctor:”陈柯”, 
      beginTime:””, 
      buyTotal:100, 
      state:1
    }],
  exampleList:[{ 
      title:”变美过程全记录”,
      desc:””,
      imageUrl:”http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg, http://img.pconline.com.cn/7.jpg”,
      username:”小美”,
      time:”2015-01-14”,
      essence:1,
      publicationPhoto:1,
      exampleID:””
    }]
  }
}

获取标签列表

getLabelList

说明

根据活动获取标签,标签读取该活动归属的项目二级分类下的所有项目名称

提交方式

GET

数据来源

提交给整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
activitiesID活动ID String ""是

返回 

{
  status:0,
  msg:”请求成功”,
  data:[{labelID:1111,
    labelName:"双眼皮"}]
}

发表晒单

showOrder

说明

购买成功后可以发表晒单

提交方式

POST

数据来源

提交给整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是
orderID订单号 String ""是
title标题 String ""是
content内容 String ""是
image图片地址 String ""是
label标签 String ""否

返回 

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

获取项目介绍信息 (web页)

getProjectInfo

说明

获取案例列表

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
projectID项目IDString""是

返回 

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

意见反馈 /版本更新

说明

调用魔方

登录/注册/重置密码/修改密码

说明

调用passport

Attachments