大众途游联盟电子票数据接口说明

目录

1.请求参数说明
1.1.接口域名说明
1.2.接口访问权限
1.3.签名参数
2.返回数据说明
2.1.返回数据说明
2.2.异常(错误码)说明
3.产品列表接口
http://test.hishihui.cn/index.php/api_v1/
4.订单列表接口
http://test.hishihui.cn/index.php/api_v1/
3.下单接口
http://test.hishihui.cn/index.php/api_v1/

1.请求参数说明

1.1、接口域名说明
测试接口域名为:test.hishihui.cn
1.2、接口访问权限
改版本数据接口暂只对系统中分销商帐户开通,供应商功能请关注接口升级
1.3、签名参数
接口请求时,需要通过签名参数验证请求方访问权限,签名参数的生成规则为:
MD532位小写md5(username.md5(password))
其中username代表请求者在系统中的登录用户名,password为登录密码;
接口请求方式为POST;

2.返回数据说明

2.1.返回数据格式统一为json格式,返回数据包含四部分:
success: 表示成功和失败的状态:1为成功、0为失败;
msg:提示信息,当请求失败时,返回文本错误信息,请求成功时返回空; error:错误码,当请求失败时,返回错误码号;
返回数据: list: 多条信息列表;row: 单条信息;
2.2.异常(错误码)说明
1. 10001=>系统错误
2. 10002=>没有数据
3. 10003=>用户名或密码错误
4. 10004=>用户余额不足
5. 20001=>未知错误

3.产品列表接口

3.1.接口地址:
Http://test.hishihui.cn/index.php/api_v1/
3.2.请求类型:
POST
3.3.请求参数:
名称 类型 是否必须 描述
action String 必须(固定) product_list
sign String 必须 见签名方式
ver Num 可选 默认为:1
page Num 可选 显示页数
size Number 可选 每页获取数量,缺省为15条
cate_id Number 可选 产品分类ID,缺省无,不作条件
zone Number 可选 产品地区ID缺省无,不作条件
pid String 可选 产品ID,用于获取确定的产品,多个
请用英文逗号分隔,缺省无,不作条件
keyword String 可选 产品名称搜索关键字, 缺省无,不作条件
3.4.返回结果:
名称 类型 描述
success Number 成功返回1失败返回0
msg String 提示信息
error Number 错误代码,见异常(错误码)说明
total Number 查询记录总数
list Array 产品列表
   id Number 产品ID
   supplie Number 供应商ID
   title String 产品名称
   content String 产品图文介绍
   image String 产品图片
   price Number 产品代理价
   price_xs Number 产品销售价
   price_ms Number 产品门市价
   send_type Number 产品发送类型:1.验证但不发送电子票 2.短信电子票
   message String 电子票模板
   pay_type Number 支付方式:1.前台现付 2.在线支付
   is_idcard Number 是否需要身份证:0.不需要 1.需要
   most_num Number 一单最多预订数量:0.不限制 非0.具体数量
   province Number 产品所在省份ID
   city Number 产品所在城市ID
   vtime_type Number 产品有效时间类型:1.指定天数 2.固定日期
   vtime_day Number 产品有效时间天数:0.不限制 非0.具体天数
当产品有效时间类型为1时有效
   vtime_start Number 产品有效开始时间戳
当产品有效时间类型为2时有效
   vtime_end Number 产品有效结束时间戳
当产品有效时间类型为2时有效
   week String 产品可使用星期 0为星期天,其它数字为具体星期日期,中间用英文逗号分隔
如:0,1,2,3为星期天、星期1、星期2、星期3
   info String 预订说明及备注
   ref_time Number 产品排序时间戳,值越大越靠前
附件属性返回结果
名称 类型 描述
sight_name String 景点名称
ad_date Number 最晚下单时,0代表当天,1,代表前一天,2代表前2天,3代表前三天。
ad_time Time 最晚下单时刻,20:00:00 代表晚上的20点之前都可以下单,20点之后就不能下单。
如果是当天0点0分表示无预定时间限制
fee_info String 费用说明。

4.订单列表接口

4.1.接口地址:
Http://test.hishihui.cn/index.php/api_v1/
4.2.请求类型:
POST
4.3.请求参数:
名称 类型 是否必须 描述
action String 必须(固定) order_list
sign String 必须 见签名方式
ver Num 可选 默认为:1
page Num 可选 显示页数
size Number 可选 每页获取数量,缺省为15条
pid String 可选 产品ID,用于获取确定的产品,多个请用英文逗号分隔,缺省无,不作条件
oid String 可选 订单ID,用于获取确定的订单,多个请用英文逗号分隔,缺省无,不作条件
code String 可选 订单码号,缺省无,不作条件
4.4.返回结果:
名称 类型 描述
success Number 成功返回1失败返回0
msg String 提示信息
error Number 错误代码,见异常(错误码)说明
total Number 查询记录总数
list Array 订单列表
 id Number 订单ID
 code String 订单码号
 visit_date Number 游玩日期时间戳
 suid Number 供应商ID
 pid Number 产品ID
 product String 产品名称
   qty Number 预订数量
   qty_yxf Number 已消费数量
   qty_tp Number 已退票数量
   price_js Number 产品代理价
   price_xs Number 产品销售价
   price_ms Number 产品门市价
   guest_name String 客人姓名
   mobile String 客人手机
   id_card String 身份证号
   vtime_start Number 订单有效开始时间戳
   vtime_end Number 订单有效结束时间戳
   message String 电子票内容
   pay_type Number 支付方式:1.前台现付 2.在线支付
   send_state Number 订单审核状态:1.未审核发送 2.已审核发送
   info String 订单说明及备注
   state Number 订单状态:1.未消费 2. 已消费 3.已审核 4.退票申请中 99.已作废
   valid_time Number 供应商验证时间戳
   datetime Number 订单录入时间戳

5.下单接口

5.1.接口地址:
Http://test.hishihui.cn/index.php/api_v1/
5.2.请求类型:
POST
5.3.请求参数:
名称 类型 是否必须 描述
action String 必须(固定) order_add
sign String 必须 见签名方式
ver Num 可选 默认为:1
visit_date Number 必须 游玩日期时间戳
pid Number 必选 产品ID
qty Number 必选 数量
guest_name String 必选 游客姓名
mobile String 必选 游客手机
id_card String 可选 根据产品属性录入
info String 可选 订单说明及备注
5.4.返回结果:
名称 类型 描述
success Number 成功返回1失败返回0
msg String 提示信息
error Number 错误代码,见异常(错误码)说明
code String 成功时返回订单码号