wiki:yimei1.0.0_api

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

--

Table of Contents

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

医美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”
    }]
}

特色展示(CMS)

getShowList

说明

获取特色展示,2条

提交方式

GET

数据来源

CMS

参数

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

返回 

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

活动专场(CMS)

getAcitivitiesSpecialList

说明

获取活动专场,3条

提交方式

GET

数据来源

CMS

参数

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

返回 

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

新增用户

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
    }
}

完善用户资料

updateUserInfo

说明

完善用户资料

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id 用户IDString""是
nickname 昵称String""否
headUrl 头像地址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”,
      activitiesID:”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”
    }]
  }
}

获取专场列表

getSpecialList

说明

获取专场列表

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

获取专场详情

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
    }
  ]
}

获取优惠活动列表

getDiscountActivitiesList

说明

获取优惠活动列表

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int10是
project项目String""否
age年龄段int""否
city城市String""否
specialID专场String""否
order排序String"1"否
businessID商家String""否
buyOther购买了该活动的用户还购买了其它的。String""否

返回 

{
  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
    }
  ]
}

获取活动详情(web页)

getActivitesInfo

说明

获取活动详情

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

提交订单

createOrder

说明

抢购后生成订单

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识""是
activitiesID活动String""是
total购买数量 int ""是
price单价 int ""是
totalPrice总价 int ""是
phoneNum手机号String""是
needScore所需积分String""否

返回 

{
  status:0,
  msg:”请求成功”,
  data:{
    orderID:"12424234234",
useMaxScore:300,
totalScore:1000
  }
}

支付通知

payNotice

说明

支付成功后通知后台 ,并获取消费密码和奖励积分

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
common_session_id用户标识String""是
orderID订单号String""是
useScore消费的积分String""是

返回 

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

获取标签列表

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:”请求成功”
}

获取部位列表

getPositionList

说明

获取部位列表

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

获取二级部位列表

getSubPositionList

说明

获取二级部位列表

提交方式

GET

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
typeID部位类型String""是

返回 

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

获取项目列表

getProjectList

说明

获取项目列表

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  total:11,
  data:[{
    typeID:"1",
    name:”眼部”,
    item:[{
      projectID:”101”,
        name:”埋线双眼皮”
    }]
   }]
}

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

getProjectInfo

说明

获取案例列表

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

获取案例列表

getExampleList

说明

获取案例列表

提交方式

POST

数据来源

整形库编辑后台

参数

参数名 参数含义 类型 默认值 是否必须
pageNo页数int1是
pageSize页面大小int3是
likeProject项目String""否
positionID部位IDString""否
projectID项目IDString""否
doctorID医生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:””
    }
  ]
}

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

getExampleInfo

说明

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

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

收藏/取消收藏

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
}

获取用户订单

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:59,
    state:1,
    showOrderID:"23423432"
   }]
}

获取订单详情

getOrderInfo

说明

获取订单详情

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

{
  status:0,
  msg:”请求成功”,
  pageNo: 1, 
  pageSize: 20,
  total: 100,
  data:{
    phoneNum:"13588888888",
    failureTime:”2015-04-15”,
    useTime:”2015-01-01” ,
    orderTime:” 2014-12-01”,
    pwd:[{
       password:”111111”,
      state:1,
      showPhotoID:””
      }]
   }
}

获取用户积分

getUserScore

说明

获取用户积分

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

获取历史积分

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
   }
}

签到

getMyScore

说明

签到

提交方式

GET

数据来源

整形库编辑后台

参数

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

返回 

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

获取收藏列表

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, 
      isEnd: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:””
    }]
  }
}

医院主页

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””
    }]}
  }
}

获取医院详细信息(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:””
   }]
}

医生主页

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:""
  }
}

意见反馈 /版本更新

说明

调用魔方

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

说明

调用passport

Attachments