在线接口文档中心

API说明: API调用说明订单状态推送通知说明

开放产品: 国内机票; 酒店; 火车票; 门票; 电影票; 保险接口; 汽车票

汽车票

磐河数据汽车票API，将互联网新兴产业与传统公路客运行业相结合，采用信息化电子商务产品的方式为旅客提供出行信息消费服务，打通公路客运购票最后一公里，全面快速提升公路客运行业信息化服务水平，改变传统公路客运服务形式，每年为数十亿人次提供公路客运出行信息服务，满足百姓的出行信息消费需求，贡献更大的社会价值

API
联系我们

获取城市接口
查询目的地接口
班次查询接口
检验余票数和票价
预订下单接口
出票代扣接口
订单详情接口
取消订单接口

接口地址： http://接口域名/bus/GetAllCity

返回格式： json

请求方法： get

请求示例： http://接口域名/bus/GetAllCity?appKey=您申请的APPKEY

请求参数：

参数名称	类型	必填	说明

返回参数：

参数名称	类型	说明
name	string	城市名称
pinyin	string	城市拼音全拼
shortPinyin	string	城市拼音简拼
cityCode	string	城市代码(查询班次时用该字段值查询)

JSON返回示例 :

{
  "data": [
    {
      "name": "乌镇",
      "pinyin": "wuzhen",
      "shortPinyin": "wz",
      "cityCode": "wuzhenzhen"
    },
    {
      "name": "仙居县",
      "pinyin": "xianjuxian",
      "shortPinyin": "xjx",
      "cityCode": "xianjuxian"
    }
  ],
  "success": true,
  "msg": "请求成功"
}

接口地址： http://接口域名/bus/getDestinationCity

返回格式： json

请求方法： get

请求示例： http://接口域名/bus/getDestinationCity?appKey=您申请的APPKEY&startCityCode=hefeishi

请求参数：

参数名称	类型	必填	说明
startCityCode	string	是	出发城市代码

返回参数：

参数名称	类型	说明
name	string	城市名称
pinyin	string	城市拼音全拼
shortPinyin	string	城市拼音简拼
pinyinCode	string	城市代码

JSON返回示例 :

{
  "data": [
    {
      "name": "乌镇",
      "pinyin": "wuzhen",
      "shortPinyin": "wz",
      "pinyinCode": "wuzhenzhen"
    },
    {
      "name": "仙居县",
      "pinyin": "xianjuxian",
      "shortPinyin": "xjx",
      "pinyinCode": "xianjuxian"
    }
  ],
  "success": true,
  "msg": "请求成功"
}

接口地址： http://接口域名/bus/queryBus

返回格式： json

请求方法： get

请求示例： http://接口域名/bus/queryBus?appKey=您申请的APPKEY&fromCityCode=hefeishi&toCityCode=zhoukoushi&fromDate=2020-10-20

请求参数：

参数名称	类型	必填	说明
fromCityCode	string	是	出发城市代码
toCityCode	string	是	到达城市代码
fromDate	string	是	出发日期

返回参数：

参数名称	类型	说明
schedules	BusScheduleInfo[]	汽车班次（数组）
scheduleId	string	车次ID（下单必传）
scheduleNo	string	车次号
fromStaionId	string	始发站ID
fromStaionName	string	始发站名称
toStaionId	string	到达站ID
toStaionName	string	到达站名称
fromDateTime	string	出发时间
mile	string	里程（单位：km，不一定有值）
runTime	string	运时（不一定有值）
schTypeName	string	客运类型（普通、豪华、流水等）
busTypeName	string	车型（大型高一、大型高二等）
liushui	string	流水班次返回返回最迟发车时间(如：18:29)
checkPoint	string	检票口
leftTicketNum	int	余票数
routeDetails	string	线路详情（途径站等信息）
lineId	string	线路ID
fullFarePrice	decimal	全票价
halfFarePrice	decimal	半票价

JSON返回示例 :

{
  "data": {
    "schedules": [
      {
        "scheduleId": "2020-10-20,06:20,20201020hg819^411600,41160001,34010001",
        "scheduleNo": "20201020hg819^411600",
        "fromStaionId": "10144",
        "fromStaionName": "合肥汽车站(明光路汽车站)",
        "toStaionId": "",
        "toStaionName": "周口道口",
        "fromDateTime": "2020-10-20 06:20:00",
        "mile": "0",
        "runTime": "",
        "schTypeName": "普通",
        "busTypeName": "中型高一座席(宇通)",
        "liushui": null,
        "checkPoint": "6",
        "leftTicketNum": 40,
        "routeDetails": "合肥→沈丘→项城→周口道口→舞阳→叶县→许昌道口→平顶山→汝州→郑州→洛阳",
        "lineId": "6534451",
        "fullFarePrice": 120.0,
        "halfFarePrice": null
      },
      {
        "scheduleId": "2020-10-20,08:30,20201020hg820^411600,41160001,34010001",
        "scheduleNo": "20201020hg820^411600",
        "fromStaionId": "10144",
        "fromStaionName": "合肥汽车站(明光路汽车站)",
        "toStaionId": "",
        "toStaionName": "周口道口",
        "fromDateTime": "2020-10-20 08:30:00",
        "mile": "0",
        "runTime": "",
        "schTypeName": "普通",
        "busTypeName": "大型高一座席(宇通)",
        "liushui": null,
        "checkPoint": "6",
        "leftTicketNum": 43,
        "routeDetails": "合肥→太和道口→界首→沈丘→项城→周口道口→漯河→舞阳→许昌道口→临颖→汝州→郑州→洛阳",
        "lineId": "6534451",
        "fullFarePrice": 120.0,
        "halfFarePrice": null
      }
    ]
  },
  "success": true,
  "msg": "请求成功"
}

接口地址： http://接口域名/bus/checkLeftTicketNumAndPrice

返回格式： json

请求方法： get

请求示例： http://接口域名/bus/checkLeftTicketNumAndPrice?appKey=您申请的APPKEY&fromCityCode=chengshia&scheduleId=2020-08-26,08:30,60003,1,3&lineId=7078514&fromDate=2020-08-26

请求参数：

参数名称	类型	必填	说明
fromCityCode	string	是	出发城市代码
scheduleId	string	是	车次ID
lineId	string	是	线路id
fromDate	string	是	出发日期

返回参数：

参数名称	类型	说明
leftTicketNum	int	余票数
status	string	1可售，0不可售
fullFarePrice	decimal	全票价
halfFarePrice	decimal	半票价

JSON返回示例 :

{
    "data": {
        "leftTicketNum": 40,
        "status": "1",
        "fullFarePrice": 120.0,
        "halfFarePrice": null
    },
    "success": true,
    "msg": "请求成功"
}

接口地址： http://接口域名/bus/createOrder

返回格式： json

请求方法： get

接口说明：

下单成功请及时支付,新订单超过30分钟未支付订单将自动取消。

请求参数：

参数名称	类型	必填	说明
fromCityCode	string	是	出发城市代码
toCityCode	string	是	到达城市代码
fromCityName	string	是	出发城市名称
toCityName	string	是	到达城市名称
fromStation	string	是	出发站名称
toStation	string	是	到达站名称
fromDateTime	string	是	出发日期时间
scheduleId	string	是	车次ID
lineId	string	是	线路ID
insuranceCodes	string	是	保险产品编号，由我方提供（有值，则表示此单购买保险）
Contact	ContactInfo	是	取票人信息
name	string	是	取票人姓名
cardType	string	是	取票人证件类型（目前仅支持身份证:1）
cardNo	string	是	取票人证件号码
mobile	string	是	取票人手机号
passengers	PassengerInfo[]	是	乘客信息（数组）
name	string	是	乘客姓名
cardType	int	是	乘客证件号码（目前仅支持身份证:1）
cardNo	string	是	乘客证件号
mobile	string	是	乘客手机号
ticketType	string	是	汽车票票种（全票：1，半票：2）

返回参数：

参数名称	类型	说明
orderNo	string	汽车票订单号

JSON请求示例 :

{
  "appKey": "您申请的APPKEY",
  "customerOrderNo": "489431656635",
  "orderAmount": 122,
  "fromCityCode": "hefeishi",
  "toCityCode": "zhoukoushi",
  "fromCityName": "合肥市",
  "toCityName": "周口市",
  "fromStation": "合肥汽车站(明光路汽车站)",
  "toStation": "周口道口",
  "fromDateTime": "2020-10-20 06:20",
  "scheduleId": "2020-10-20,06:20,20201020hg819^411600,41160001,34010001",
  "lineId": "6534451",
  "insuranceCodes": null,
  "callBackUrl": "http://otatest.panhe.net/test/Notify",
  "contact": {
    "name": "张三",
    "mobile": "13918489242",
    "cardType": 1,
    "cardNo": "370920195109070071"
  },
  "passengers": [
    {
      "name": "李四",
      "cardType": 1,
      "cardNo": "370920195109070071",
      "mobile": "13918489242",
      "ticketType": 1
    }
  ]
}

JSON返回示例 :

{
  "data": {
    "orderNo": "BO2010195017"
  },
  "success": true,
  "msg": "请求成功"
}

接口地址： http://接口域名/bus/autoPay

返回格式： json

请求方法： get

请求参数：

参数名称	类型	必填	说明
orderNo	string	是	汽车票订单号
payAmount	decimal	否	支付金额，为空（null）不校验，传值就会和订单总金额比对，一致才能代扣成功(传值时就参与签名，为null时不参与签名)
sign	string	是	签名校验值，md5(secretKey+orderNo+payAmount+secretKey)，secretKey为请求密钥，开通账户时即可获得。加密结果转为32位小写

返回参数：

参数名称	类型	说明
success	bool	true表示支付成功；false表示支付失败,msg为支付失败原因。出票结果以异步回调结果为准

JSON请求示例 :

{
  "appKey": "您申请的APPKEY",
  "orderNo": "BO2010195017",
  "payAmount": 122,
  "sign":"17fb3f159a93cf6a5d0275565d1a0954"
}

JSON返回示例 :

{
    "data": true,
    "success": true,
    "msg": "请求成功"
}

接口地址： http://接口域名/bus/getOrderDetail

返回格式： json

请求方法： get

请求示例： http://接口域名/bus/getOrderDetail?appKey=您申请的APPKEY&orderNo=BO2010195017

请求参数：

参数名称	类型	必填	说明
orderNo	string	是	汽车票订单号

返回参数：

参数名称	类型	说明
orderNo	string	订单号
orderAmount	float	订单总金额
ticketAmount	float	汽车票票款总金额
orderStatus	int	订单状态（1=新订单待支付，2=已支付待出票，3=出票中，4=已出票，5=不能出票待退款，6=不能出票退款中，7=不能出票已退款，99=已取消）
orderStatusName	string	订单状态名称
transactionNo	string	支付成功交易单号
ticketTime	string	出票时间
insuranceCodes	string	购保保险代码
customerOrderNo	string	商户订单号
fromCityCode	string	出发城市代码
toCityCode	string	到达城市代码
fromCityName	string	出发城市名称
toCityName	string	到达城市名称
fromStation	string	出发汽车站
toStation	string	到达汽车站
fromDateTime	string	出发时间
contact_Name	string	联系人
contact_CardType	int	联系人证件类型（1=身份证， 2=护照）
contact_CardNo	string	联系人证件号
contact_Mobile	string	联系人手机号
ticketsCount	int	票数
busTickets	BusTicketsInfo[]	车票信息，数组
name	string	乘客姓名
cardType	int	乘客证件类型（1=身份证， 2=护照）
cardNo	string	乘客证件号
mobile	string	乘客手机号
ticketType	int	票种（1=全票，2=半票）
ticketPrice	float	票价

JSON返回示例 :

{
  "data": {
    "orderNo": "BO2010281157",
    "orderAmount": 52.00,
    "ticketAmount": 50.00,
    "serviceFeeAmount": 2.00,
    "insuranceAmount": 0.00,
    "orderStatus": 99,
    "orderStatusName": "已取消",
    "transactionNo": null,
    "ticketTime": null,
    "insuranceCodes": null,
    "customerOrderNo": "489431656635",
    "fromCityCode": "hefeishi",
    "toCityCode": "chuzhoushi",
    "fromCityName": "合肥市",
    "toCityName": "滁州市",
    "fromStation": "合肥汽车站(明光路汽车站)",
    "toStation": "滁州汽车站",
    "fromDateTime": "2020-10-29 08:50:00",
    "contact_Name": "张三",
    "contact_CardType": 1,
    "contact_CardNo": "370920195109070071",
    "contact_Mobile": "13710487345",
    "payLimitTime": "2020-10-28 20:27:28",
    "unFinishedReason": "订单已取消,交易关闭",
    "outTicketFail_RefundSuccessTime": null,
    "outTicketFail_RefundTransactionNo": null,
    "outTicketFail_RefundAmount": null,
    "outTicketFail_RefundTransactionMethods": 0,
    "fullFarePrice": 50.00,
    "halfFarePrice": 0.00,
    "scheduleId": "2020-10-29,08:50,20201029hg902^341100,34110000,34010001",
    "lineID": "6536182",
    "ticketsCount": 1,
    "createTime": "2020-10-28 19:57:28",
    "busTickets": [
      {
        "name": "李四",
        "cardType": 1,
        "cardNo": "370920********70071",
        "mobile": "13710487345",
        "ticketType": 1,
        "ticketPrice": 50.00
      }
    ]
  },
  "success": true,
  "msg": "请求成功"
}

接口地址： http://接口域名/bus/cancelOrder

返回格式： json

请求方法： post

请求示例： http://接口域名/bus/cancelOrder?appKey=您申请的APPKEY&orderNo=BO2010195017&remark=行程取消了

请求参数：

参数名称	类型	必填	说明
orderNo	string	是	汽车票订单号
remark	string	是	取消缘由

返回参数：

参数名称	类型	说明
data	bool	true表示取消成功；false表示取消失败,msg为取消失败原因。

JSON返回示例 :

{
    "data": true,
    "success": true,
    "msg": "请求成功"
}

联系我们

	内容	详细
	售前咨询:	15021905015
	客服热线:	17306152795
	在线客服QQ:	1437759532
	测试工具:	推荐使用PostMan
	技术支持:	info@panhe.net