API文档

来自技术开发小组内部wiki
跳转至： 导航、 搜索

主要用来整理提供给IOS使用的各种分类api接口，便于快速阅读，修改与查看，模板参考：V1/user/get info

接口约定说明

  1. 系统参数：参数format来决定返回什么格式数据，目前仅支持xml,json,不参加签名.
  2. 系统参数：sign：生成的签名，调用者必须传入该参数,不参加签名.
  3. 系统参数：appid：调用者使用的appid，调用者必须传入该参数,不参加签名.
  4. 系统参数：imgupload：保留为以后上传图片使用，暂时无用，不参加签名。
  5. 接口命名：统一采用v1/user/get_info形式，即方法名采用下划线进行适当的分隔，不适用驼峰命名法.
  6. 请求方法：除format参数外，其他参数均采用post(json/xml)方式来提交.
  7. 字符编码：通一采用'error_code'=>'200001','error_msg'=>'参数不是数字'.
  8. 错误返回：通一采用uft-8编码.
  9. 安全传输：支持https传输,保证数据传输安全.
  10. 域名：接口域名分三种：
本地环境:dev-api.fumubang.net;内部开发人员开发调试用的，APP开发人员不用管.
测试环境：api.fumubang.net;目前APP开发人员可以使用此地址.
正式环境：api.fumubang.com;线上正式环境地址，发布到线上后使用此地址.
建议APP开发人员将此域名做成可动态切换的，方便以后发布到线上！

签名规范说明

<syntaxhighlight lang="php">
1:在请求参数列表中,除去sign,appid,imgupload三个参数外，其他需要使用到的参数皆是要签名的参数
2:对参数里的每一个值从a到z的顺序排序。排序完成之后，再把所有数组值以“&”字符连接起来
3:在MD5 签名时，需要把appkey连接起来再做md5签名.

PHP签名算法如下：
<?php
        function verification($arr,$appkey){
           //过虑生成新的数组

$para_filter = array(); foreach ($arr as $key => $val ) { if( in_array($key,array('sign','appid','imgupload')) || $val == "")continue; else $para_filter[$key] = $arr[$key]; } //排序数组 ksort($para_filter); reset($para_filter);

//再把所有数组值以“&”字符连接起来 $arg = ""; foreach ($para_filter as $key => $val ) { $arg.=$key."=".urlencode($val)."&"; }

//去掉最后一个&字符 $arg = substr($arg,0,count($arg)-2); 

          //如果存在转义字符，那么去掉转义

if(get_magic_quotes_gpc()){$arg = stripslashes($arg);} $prestr = $arg . $appkey; 

          return md5($prestr);

} </syntaxhighlight>

登陆API列表

主要用来处理登陆相关的接口，比如登陆，更改密码，忘记密码，返回用户信息等
接口分类 接口功能说明 接口详细文档
登陆api 用户进行登陆 V1/login/login in
给用户发送手机验证码 V1/login/send messages
用户手机注册验证手机号并下发验证码 V1/login/mobile reg messages
check验证码 V1/login/check invitation
check手机号 V1/login/check phone
手机号注册 V1/login/reg account
QQ号码注册 V1/login/qq reg account
微信注册 V1/login/weixin reg account
手机找回密码 V1/login/phone locate password
邮箱找回密码 V1/login/email locate password
修改密码 V1/login/modfiy pass
账号合并
 V2/login/bind mobile

活动API列表

主要用来汇总与活动相关的API列表
接口分类 接口功能说明 接口详细文档
活动api 获取活动列表(现在app没调用) V1/activity/get list info（已废弃）
获取单个活动详情,支持可报名，可购买的 V1/activity/get single info
获取多个活动详情,支持可报名，可购买的（未使用）
 V1/activity/get mutli info
获取活动精彩推荐（未使用）
 V1/activity/get special recommend
活动报名
 V1/activity/apply
活动提问 V1/activity/ask question
活动分类列表
 V1/activity/get category list
活动咨询列表 V1/activity/get question list
用户取消/关注活动 V1/activity/like
获取会员福利列表 V1/activity/free activity list
活动团体定制
 V2 0/activity/activity custom
活动报名列表
 V2 0/activity/get apply list
获取在线选座单个场次
 V2 0/activity/get single dp
获取在线选座当前场次区域座位信息
 V2 0/activity/get seat info
获取当前活动的可选优惠券列表
 V2 0/activity/get activity coupon
领取优惠券
 V2 0/activity/distribute coupon
格瓦拉实体票根据票种获取可配送省份
 V2 0/activity/get seat provinces

团购API列表

主要用来汇总与团购商品相关的API列表
接口分类 接口功能说明 接口详细文档
团购api 获取团购列表
 V1/group tickets/get list info
获取单个团购详情（暂没用,均用活动详情页API）
 V1/group tickets/get single info
获取多个团购详情（暂没用,均用活动详情页API） V1/group tickets/get mutli info
获取具体某个团购支持的支付类型
 V1/group tickets/get pay type list
获取标签对应的活动列表
 V2 0/group tickets/get list bytag

商户API列表

主要用来汇总与本地商户相关的API列表
接口分类 接口功能说明 接口详细文档
商户api 获取单个商户详情 V1/shop/get single info

母婴问答API列表

主要用来汇总一些母婴问答的api接口
接口分类 接口功能说明 接口详细文档
母婴API 获取一组母婴问答列表 V1/child/child news group
获取单个新闻信息 V1/child/news info
收藏文章，删除文章 V1/child/like
文章搜索/文章分类列表
 V2 0/child/search all

用户API列表

主要用来处理用户相关的数据获取接口
接口分类 接口功能说明 接口详细文档
用户api 获取用户的电子兑换券 V1/user/my exchange code
获取用户的订单列表 V1/user/my order list
获取用户参与活动列表 V1/user/my activity list
获取用户收藏的文章列表 V1/user/my news list
获取用户的基本信息 V1/user/my basic info
获取用户的消息列表 V1/user/my msg list
获取用户的订单详情 V1/order/get single info
获取用户的收货地址信息 V1/user/my address list
添加用户的收货地址信息 V1/user/add my address
设置用户的收货地址信息 V1/user/set my address
获取退货原因列表 V1/user/return list
修改用户手机号码 V1/user/modfiy mobile
修改用户信息 V1/user/change user info
优惠券列表 V1/user/my coupon list
激活券列表 V1/user/activate coupon
退货详情 v1_6/user/my_returninfo
获取用户身份证列表
 V2 0/user/get user cert
添加身份证信息
 V2 0/user/add user cert
修改身份证信息
 V2 0/user/edit usr cert
个人中心-更改大礼包读取状态
 V2 0/user/change coupack record
意见反馈
 V2 0/user/add feed back
申请退款页面设置
 V2 0/user/apply return
提交退款申请
 V2 0/user/submit return
新增常用旅客
 V2 0/user/add user cert passenger
编辑常用旅客
 V2 0/user/edit user cert passenger
常用旅客信息列表
 V2 0/user/get user cert passenger
删除单个常用旅客信息
 V2 0/user/del user cert passenger
获取国籍列表
 V2 0/user/get nationalitys
获取证件类型列表
 V2 0/user/get cert type
新版用户反馈，可上传图片
 v2_0/user/add_feedback_image

订单API列表

主要用来汇总与订单相关的API列表
接口分类 接口功能说明 接口详细文档
订单api 获取订单详细信息，需要与用户信息绑定 V1/order/get single info
生成订单，下单用
 V1/order/submit
(无用，已经屏蔽) V1/order/modify
订单取消
 V1/order/cancel
获取订单取消原因
 V2 0/order/cancel reasons
订单发起退货 V1/order/returns
订单确认 V1/order/confirm
订单是否已支付 V1/order/pay info
重新发送验证码 V1/order/send exchange code
判断多个子订单是否支付 V1 5/order/pay info more
获取酒店订单详情，套餐改签版本（适用于1.69以上版本）
 V1 6/order/get order hotel info
获取银联支付TN,交易流水号（适用于2.0以上版本）
 V2 0/order/yinlian pay
获取微信支付prepay_id,预支付回话标识（适用于2.0以上版本）
 V2 0/order/weixin pay
获取支付宝支付拼接的字符串
 V2_0/order/alipay pay
根据地址获取运费（新运费模板读取运费）
 V2 0/order/get shipping fee
第三方选座产品确认订单
 V2 0/order/order confirm
订单支付成功获取结伴详情
 V2 0/order/get partner info

支付API列表

主要用来汇总与支付相关的API列表
接口分类
 接口功能说明 接口详细文档
支付宝异步通知
 支付宝异步通知的地址 V1/payment/alipay notify
支付宝交易关闭 V1/alipay/close trade
总订单支付的支付宝异步通知
 V1 5/payment/alipay return
银联支付异步通知
 交易成功后异步通知地址

MOBILE_TRADE_HOST."/mobile/payment/yinlian_notify_app_v2_0"

MOBILE_TRADE_HOST为http://mtrade.fumubang.com

微信支付异步通知
 交易成功后异步通知地址

MOBILE_TRADE_HOST."/mobile/payment/weixin_notify_pub_app_v2_0"

MOBILE_TRADE_HOST为http://mtrade.fumubang.com

购物车API列表

主要用来汇总购物车相关的API列表
接口分类 接口功能说明 接口详细文档
购物车接口 购物车数据查询 V1/cart/get cart list
添加商品到购物车 V1/cart/add goods
整体更新购物车 V1/cart/update
购物车生成订单接口 V1/order/cart submit
判断多个子订单是否支付 V1 5/order/pay info more

工具API列表

主要用来汇总一些公共的api接口，与具体的业务逻辑没有明显的关联，比如发送短信，发送邮件，发送私信，
接口分类 接口功能说明 接口详细文档
工具API 发送手机短信 V1/util/send sms
获取区域列表级联信息 V1/util/get area list
获取省市区三级列表信息 V1/util/get city list
获得rsa签名后的数据 V1/util/get rsa sign
记录用户设备
 V2 0/util/add user handsets record

搜索API列表

主要用来提供一些搜索相关的api接口
接口分类 接口功能说明 接口详细文档
搜索API 通用搜索接口 V1/search/search all

其他API列表

主要用来汇总不易于归类的一些API列表
接口分类 接口功能说明 接口详细文档
其他api 获取是否有版本升级信息 V1/other/check update
首页分类图标信息获取 V1/other/index category
首页推荐列表获取
 V1/other/index special recommend
首页关键字获取 V1/other/index hot keywrod
主题列表获取 V1/other/theme list
单个主题内容获取 V1/other/theme info
融云访问地址
 V2 0/rongyun/getToken
客户端启动页广告
 V2 0/other/ad index_get
APP3.2以上版本获取首页信息
 V2 0/other/index special recommend_v32

客服系统用户接口

接口分类 接口功能说明 接口详细文档
客服系统用户API
 根据用户名密码登录 Workorder/kefu/admin login
根据用户名查找其权限 Workorder/kefu/get permissions
根据用户查找其所属部门
 Workorder/kefu/get depart info
根据部门查找其拥有的用户
 Workorder/kefu/get child user
部门树结构
 Workorder/kefu/get depart all
根据手机号和订单号获取用户信息、订单信息 Workorder/kefu/get userinfo orderinfo
客服二次确认酒店订单信息
 Workorder/kefu/get kefuconfirm orderinfo
活动信息 Workorder/kefu/get activity title
添加客服备注 Workorder/kefu/add kefu note
产品一级分类列表
 Workorder/kefu/get goods category info
获取微信公众号token
 Workorder/kefu/get wx token
获取客服订单报表
 Workorder/kefu/kefu work report
获取更多活动信息
 Workorder/kefu/get more activity title
发送短信接口
 Workorder/kefu/send sms
根据订单号查询该订单对应的套餐信息
 Workorder/kefu/get hotel info by ordersn
通过uid查询该用户所有待处理中的酒店订单
 Workorder/kefu/get confirm hotel by uid
客服接口定时获取某时间段内新上的活动
 Workorder/kefu/get new activitys
获取客服电话
 Workorder/kefu/get kefu phone
订单改签自动创建工单接口 Api/mysheet/create_sheet
活动变更创建工单接口
 Api/mysheet/create_sheet_byaid
查询订单是否开发票
 Api/mysheet/query_invoice

表结构数据字典

参考：Fmb new数据结构字典

酒店API列表

主要用来汇总与酒店活动相关的API列表
接口分类 接口功能说明 接口详细文档
酒店api
 获取单个酒店活动详情
 V1_6/activity/get single info
酒店确认订单
 V1_6/order/hotel confirm
酒店生成订单
 V1 6/order/submit
酒店订单详情
 V1 6/order/get order hotel info
根据出行日期获取酒店套餐
 V2 0/activity/get hotel package bydate

现场秀API列表

主要用来汇总与现场秀相关的API列表
接口分类 接口功能说明
 接口详细文档
现场秀api
 现场秀列表
 V2 0/live show/get live show list
现场秀点赞/取消赞
 V2 0/live show/live show favour
查看更多评论
 V2 0/live show/live show comments
添加评论
 V2 0/live show/add live show comment

长线游API列表

主要用来汇总与长线游产品相关的API列表
接口分类 接口功能说明
 接口详细文档
长线游api
 长线游列表
 V2 0/longtour/get_product_list_long
长线游详情页
 V2 0/longtour/get_single_info
推荐行程
 V2 0/longtour/get trip schedule
获取长线游优惠券列表
 V2 0/longtour/get coupon list long
自由行选定方案
 V2 0/longtour/get_pack_free_bydate
自由行选定方案后校验库存并返回优惠券、联系人
 V2 0/longtour/check pack free bydate
自由行提交订单
 V2 0/order long/add order free
跟团游选择出行日期后检验库存
 V2 0/longtour/check_pack group bydate
跟团游提交订单
 V2 0/order long/add order group
长线游订单详情
 V2 0/order long/get order info long

结伴游API列表

主要用来汇总与结伴游产品相关的API列表
接口分类 接口功能说明
 接口详细文档
结伴游api
 结伴游列表
 V2_0/partner/get_list_info
结伴分享记录用户分享码
 v2_0/partner/record_invite_code

消息API列表

主要用来汇总与消息相关的API列表
接口分类 接口功能说明
 接口详细文档
消息api
 消息列表
 V2 0/message/get_message_list
精彩推荐列表
 V2 0/message/get_recommand_list
系统消息列表
 V2 0/message/get_system_list
订单消息列表
 V2 0/message/get_order_list
退款消息
 V2 0/message/get_order_return_list
报名消息列表
 V2 0/message/get_apply_activity_list
咨询消息列表
 V2 0/message/get_ask_list
优惠券消息
 V2 0/message/get_coupon_list
更新消息成已读
 V2 0/message/update_message_status
是否有新消息
 V2 0/other/get_new_message_count
取自“http://wiki.fumubang.net/index.php?title=API文档&oldid=6491”