Changes between Version 6 and Version 7 of yimei1.0.0_api


Ignore:
Timestamp:
03/10/2015 01:55:33 PM (11 years ago)
Author:
caomenglin
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • yimei1.0.0_api

    v6 v7  
    22 
    33= 医美1.0.0接口文档 =  
     4== 引导页项目列表(CMS) ==  
     5 
     6> getGuidProjectList 
     7 
     8**说明** 
     9 
     10>获取引导页中的项目, ID对应整形库中的,但名称可能不一样。 
     11 
     12**提交方式** 
     13 
     14>GET 
     15 
     16**数据来源** 
     17 
     18> CMS 
     19 
     20**参数** 
     21 
     22||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     23 
     24**返回** 
     25 
     26{{{#!java 
     27{ 
     28  status:0, 
     29  msg:”请求成功”, 
     30  data:[{ 
     31    typeID:"1", 
     32    name:”眼部” 
     33   }] 
     34} 
     35 
     36}}} 
     37 
     38 
     39---------- 
     40 
     41 
     42== 焦点图(CMS) ==  
     43 
     44> getFocusList 
     45 
     46**说明** 
     47 
     48>获取焦点图,最多5张 
     49 
     50**提交方式** 
     51 
     52>GET 
     53 
     54**数据来源** 
     55 
     56> CMS 
     57 
     58**参数** 
     59 
     60||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     61 
     62**返回** 
     63 
     64{{{#!java 
     65{ 
     66  status:0, 
     67  msg:”请求成功”, 
     68  data:[{ 
     69      type:1, 
     70      imageUrl:” http://img.pconline.com.cn/7.jpg”, 
     71      url:”” , 
     72      contentID:”14324” 
     73    }] 
     74} 
     75 
     76}}} 
     77 
     78 
     79---------- 
     80== 特色展示(CMS) ==  
     81 
     82> getShowList 
     83 
     84**说明** 
     85 
     86>获取特色展示,2条 
     87 
     88**提交方式** 
     89 
     90>GET 
     91 
     92**数据来源** 
     93 
     94> CMS 
     95 
     96**参数** 
     97 
     98||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     99 
     100**返回** 
     101 
     102{{{#!java 
     103{ 
     104  status:0, 
     105  msg:”请求成功”, 
     106  data: [{ 
     107      showTitle:”一元秒杀”, 
     108      showDesc:”有积分就是任性”, 
     109      imageUrl:” http://img.pconline.com.cn/7.jpg”, 
     110      url:””, 
     111      type:1, 
     112      contentID:”14324” 
     113}] 
     114} 
     115 
     116}}} 
     117 
     118 
     119---------- 
     120== 活动专场(CMS) ==  
     121 
     122> getAcitivitiesSpecialList 
     123 
     124**说明** 
     125 
     126>获取活动专场,3条 
     127 
     128**提交方式** 
     129 
     130>GET 
     131 
     132**数据来源** 
     133 
     134> CMS 
     135 
     136**参数** 
     137 
     138||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     139 
     140**返回** 
     141 
     142{{{#!java 
     143{ 
     144  status:0, 
     145  msg:”请求成功”, 
     146  data: [{ 
     147      title:”新年美肤专场,水嫩肌肤换出来”, 
     148      imageUrl:”http://img.pconline.com.cn/7.jpg”, 
     149      specialID:”14242” 
     150    }] 
     151} 
     152 
     153}}} 
     154 
     155 
     156---------- 
     157 
     158== 新增用户 ==  
     159 
     160> addUser 
     161 
     162**说明** 
     163 
     164>注册成功后,通知平台添加用户和积分 
     165 
     166**提交方式** 
     167 
     168>GET 
     169 
     170**数据来源** 
     171 
     172> 整形库编辑后台 
     173 
     174**参数** 
     175 
     176||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     177||common_session_id||用户标识||String||""||是|| 
     178 
     179**返回** 
     180 
     181{{{#!java 
     182{ 
     183  status:0, 
     184  msg:”请求成功” 
     185} 
     186 
     187}}} 
     188 
     189 
     190---------- 
     191 
    4192== 获取用户资料 ==  
    5193 
     
    30218  msg:”请求成功”, 
    31219  data:{  
     220    phoneNum:”13588888888”, 
    32221    username:”昵称”, 
    33222    percent:50, 
     
    35224    sex:"男", 
    36225    birthday:"1990-09-21", 
    37     age:21, 
     226    age:70, 
    38227    city:"广东广州", 
    39228    useProject:"整过的项目1,整过的项目2", 
     
    68257 
    69258||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    70 ||exampleID||案例ID||String||""||是|| 
     259|| common_session_id ||用户ID||String||""||是|| 
    71260||nickname ||昵称||String||""||否|| 
    72261||headUrl ||头像地址||String||""||否|| 
     
    77266||likeProject ||感兴趣的项目||String||""||否|| 
    78267||useProject ||整过的项目||String||""||否|| 
    79 ||signature  ||个性签名||String||""||否|| 
     268||signature  ||个性签名||String||""||否|| 
    80269 
    81270**返回** 
     
    159348      type:1, 
    160349      imageUrl:” http://img.pconline.com.cn/7.jpg”, 
    161       url:”” , 
     350      url:”” , 
    162351      contentID:”14324” 
    163352    }], 
     
    170359      contentID:”14324” 
    171360    }], 
    172     activities[{ 
     361    activities:[{ 
    173362      title:”新年美肤专场,水嫩肌肤换出来”, 
    174363      imageUrl:”http://img.pconline.com.cn/7.jpg”, 
    175364      activitiesID:”14242” 
    176365    }], 
    177     guessYouLike[{ 
     366    guessYouLike:[{ 
    178367      likeID:”24234”, 
    179368      title:”标题”, 
     
    235424  pageSize: 20, 
    236425  total: 100, 
    237   data:{[ 
     426  data:[{ 
    238427    title:"陈柯", 
    239428    specialID:””,  
     
    242431     buyTotal:12, 
    243432    imageUrl:"" 
    244    ]} 
     433   }] 
     434} 
     435 
     436}}} 
     437 
     438 
     439---------- 
     440== 获取专场详情==  
     441 
     442> getSpecial 
     443 
     444**说明** 
     445 
     446>获取专场列表 
     447 
     448**提交方式** 
     449 
     450>GET 
     451 
     452**数据来源** 
     453 
     454> 整形库编辑后台 
     455 
     456**参数** 
     457 
     458||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
     459||pageNo||页数||int||1||是||  
     460||pageSize||页面大小||int||4||是|| 
     461|| specialID ||专场ID||String||””||是|| 
     462 
     463 
     464**返回** 
     465 
     466{{{#!java 
     467{ 
     468  status:0, 
     469  msg:”请求成功”, 
     470  pageNo: 1,  
     471  pageSize: 20, 
     472  total: 100, 
     473  data: [{  
     474    activitiesID:””,  
     475    title:””,  
     476    typeName:””,  
     477    imageUrl””,  
     478    price:999,  
     479    discountPrice:1, 
     480    businessName:”深圳广济医疗美容医院”,  
     481    doctor:”陈柯”,  
     482    beginTime:””,  
     483    buyTotal:100,  
     484    isEnd:1 
     485    } 
     486  ] 
    245487} 
    246488 
     
    277519||order||排序||String||"1"||否|| 
    278520||businessID||商家||String||""||否|| 
     521||buyOther||购买了该活动的用户还购买了其它的。||String||""||否|| 
     522 
    279523 
    280524**返回** 
     
    297541    doctor:”陈柯”,  
    298542    beginTime:””,  
    299   buyTotal:100,  
    300   isEnd:1 
     543    buyTotal:100,  
     544    isEnd:1 
    301545    } 
    302546  ] 
     
    335579  msg:”请求成功”, 
    336580  data:{ 
    337     businessID:"商家ID", 
     581businessID:"商家ID", 
     582needScore:200, 
     583totalScore:1000, 
     584frontMoney:300, 
     585buyTotal:1, 
    338586    html:"" 
    339587  } 
     
    344592---------- 
    345593 
    346 == 抢购 ==  
    347  
    348 > quicklyBuy 
    349  
    350 **说明** 
    351  
    352 >获取活动详情  
    353  
    354 **提交方式** 
    355  
    356 >GET 
    357  
    358 **数据来源** 
    359  
    360 > 整形库编辑后台 
    361  
    362 **参数** 
    363  
    364 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    365 ||common_session_id||用户标识||""||是|| 
    366 ||activitiesID||活动||String||""||是|| 
    367  
    368 **返回** 
    369  
    370 {{{#!java 
    371 { 
    372   status:0, 
    373   msg:”请求成功”, 
    374   data:{ 
    375     total:1 
    376   } 
    377 } 
    378 }}} 
    379  
    380  
    381 ---------- 
    382 == 生成订单 ==  
     594== 提交订单 ==  
    383595 
    384596> createOrder 
     
    405617||totalPrice||总价|| int ||""||是|| 
    406618||phoneNum||手机号||String||""||是|| 
     619||needScore||所需积分||String||""||否|| 
     620 
     621 
    407622 
    408623**返回** 
     
    413628  msg:”请求成功”, 
    414629  data:{ 
    415     orderID:"12424234234" 
     630    orderID:"12424234234", 
     631useMaxScore:300, 
     632totalScore:1000 
    416633  } 
    417634} 
     
    420637 
    421638---------- 
    422 == 积分兑换 ==  
    423  
    424 > scoreConvert 
    425  
    426 **说明** 
    427  
    428 >支付时采用积分换取需要调用积分兑换  
    429  
    430 **提交方式** 
    431  
    432 >GET 
    433  
    434 **数据来源** 
    435  
    436 > 整形库编辑后台 
    437  
    438 **参数** 
    439  
    440 ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    441 ||common_session_id||用户标识||String||""||是|| 
    442 ||score||分数||int||""||是|| 
    443  
    444 **返回** 
    445  
    446 {{{#!java 
    447 { 
    448   status:0, 
    449   msg:”请求成功”, 
    450   score:115 
    451 } 
    452 }}} 
    453  
    454  
    455 ---------- 
     639 
    456640== 支付通知 ==  
    457641 
     
    475659||common_session_id||用户标识||String||""||是|| 
    476660||orderID||订单号||String||""||是|| 
     661||useScore||消费的积分||String||""||是|| 
     662 
    477663 
    478664**返回** 
     
    591777  status:0, 
    592778  msg:”请求成功”, 
    593   data:{[ 
     779  data:[{ 
    594780    typeID:"1", 
    595781    name:”眼部” 
    596    ]} 
     782   }] 
    597783} 
    598784 
     
    629815  msg:”请求成功”, 
    630816  total:11, 
    631   data:{[ 
     817  data:[{ 
    632818    typeID:"1", 
    633819    name:”眼部” 
    634    ]} 
     820   }] 
    635821} 
    636822 
     
    667853  msg:”请求成功”, 
    668854  total:11, 
    669   data:{[ 
     855  data:[{ 
    670856    typeID:"1", 
    671857    name:”眼部”, 
     
    674860        name:”埋线双眼皮” 
    675861    }] 
    676    ]} 
     862   }] 
    677863} 
    678864 
     
    8281014||common_session_id||用户标识||String||""||是|| 
    8291015||activitiesID||活动|| String ||""||是|| 
    830 || type||类型:1:活动,2:案例|| int ||""||是|| 
     1016|| type||类型:1:活动,2:案例|| int ||""||是|| 
    8311017||operation||操作:1:收藏,2:取消收藏|| int ||""||是|| 
    8321018 
     
    8641050||common_session_id||用户标识||String||""||是|| 
    8651051||activitiesID||活动|| String ||""||是|| 
    866 || type||类型: 1:活动,2:案例|| int ||""||是|| 
     1052|| type||类型: 1:活动,2:案例|| int ||""||是|| 
    8671053 
    8681054**返回** 
     
    9121098  pageSize: 20, 
    9131099  total: 100, 
    914   data:{[ 
     1100  data:[{ 
    9151101    orderID:"123442342", 
    9161102    imageUrl:””,  
     
    9211107    state:1, 
    9221108    showOrderID:"23423432" 
    923    ]} 
     1109   }] 
    9241110} 
    9251111 
     
    10071193    scoreTotal:"105", 
    10081194    days:”5”,  
    1009     monthIn:”2015-01-01”, 
    1010     monthOut:” 2014-12-01” 
     1195    monthIn:110, 
     1196    monthOut:50 
    10111197   } 
    10121198} 
     
    10601246 
    10611247---------- 
    1062 == 领取积分 ==  
     1248== 签到 ==  
    10631249 
    10641250> getMyScore 
     
    10661252**说明** 
    10671253 
    1068 >获取用户历史积分 
     1254>签到 
    10691255 
    10701256**提交方式** 
     
    10801266||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =|| 
    10811267||common_session_id ||用户标识||String||""||是|| 
     1268||score ||分数||int||1||是|| 
    10821269 
    10831270**返回** 
     
    11161303||pageSize||页面大小||int||3||是|| 
    11171304||common_session_id||用户标识||String||""||是|| 
    1118 || type||类型:1:活动,2:案例|| int ||""||是|| 
     1305|| type||类型:1:活动,2:案例|| int ||""||是|| 
    11191306 
    11201307**返回** 
     
    11951382    project:[{  
    11961383      total:20,  
    1197       list:[“玻尿酸隆鼻”, “玻尿酸隆鼻”, “玻尿酸隆鼻”] 
     1384      list:[{ 
     1385    typeID:"1", 
     1386    name:”眼部” 
     1387   }] 
    11981388    }], 
    11991389  example:{ 
     
    13071497  pageSize: 20, 
    13081498  total: 100, 
    1309   data:{[ 
     1499  data:[{ 
    13101500    name:"陈柯", 
    13111501    doctorID:””,  
    13121502    imageUrl:””,  
    1313     job:””,  
    1314    ]} 
     1503    job:”” 
     1504   }] 
    13151505} 
    13161506