由春秋统一分配给供应商,供调用平台API所使用:
名称 |
类型 |
说明 |
appKey |
String |
应用键,由春秋分配给供应商,如:13245 |
appSecret |
String |
应用值,由春秋分配给供应商,如:abcd |
春秋旅游API开放平台调用为HTTP 方式,调用者可以按一定格式自行拼装HTTP请求进行调用。
名称 |
地址 |
正式环境 |
http://openapi.springtour.com/openapi/router |
测试环境 |
http://124.74.46.118:5001/openapi/router |
名称 |
类型 |
是否必输 |
说明 |
sign |
String |
是 |
签名,参考本节1.6 |
method |
String |
是 |
服务方法名称,如:grouptour.book |
format |
String |
是 |
指定响应格式:json |
appKey |
String |
是 |
应用键,由春秋分配给供应商 |
locale |
String |
是 |
本地化类型,默认为:zh_CN |
v |
String |
是 |
服务方法版本号,如:1.0,2.0等 |
1、将所有请求参数按参数名排序(升序)
2、将请求参数名及参数值拼接成字符串,如:paramName1paramValue1paramName2paramValue2
3、将appSecret分别添加到请求参数串的头部和尾部,如:appSecret请求参数字符串appSecret
4、对该字符串进行 SHA1 运算,得到一个二进制数组
5、将该二进制数组转换为十六进制的字符串,该字符串即是sign的值
6、将生成的sign作为系统参数拼接在URL里。
以调用预定接口为例,请求URL的拼接为:
http://124.74.46.118:5001/openapi/router?
sign=qazwsxedc&method=grouptour.book&format=json&appKey=12345&locale=zh_CN&v=2.0&groupTourItemBook={}
备注:”{}”要替换为json格式化之后的groupTourItemBook对象
功能描述 |
根据输入条件查询满足条件的产品 |
|||
接口名称 |
product.queryBaseInfo |
|||
接口版本 |
2.0 |
|||
请求方式 |
post |
|||
请求格式 |
json |
|||
请求参数 |
QueryProductRequest |
|||
名称 |
类型 |
中文名 |
是否必填 |
备注 |
入参对象 |
必输 |
systemType、productAttribute必输 |
||
productId |
number |
春秋产品id |
可选 |
|
productAttribute |
number |
产品属性 |
必输 |
7团队游 13 自由行 |
productName |
String |
产品名称 |
可选 |
|
systemType |
number |
系统类型 |
必输 |
0国内 1出境 |
days |
number |
天数 |
可选 |
|
departCityId |
number |
出发地 |
可选 |
|
destinationCityId |
number |
目的地 |
可选 |
|
ticketCategoryId |
number |
资源id |
可选 |
|
ticketCategoryName |
String |
资源名称 |
可选 |
|
pagination |
分页信息 |
必输 |
|
|
currentPage |
number |
当前页数 |
|
|
pageSize |
number |
每页展示条数 |
|
|
totalCount |
number |
总条数 |
|
|
基本参数 |
|
|||
名称 |
类型 |
备注 |
|
|
successful |
boolean |
true 成功 false 失败 |
|
|
errorResponse |
string |
错误详情 |
|
|
successResponse |
string |
|
|
|
productBaseInfoList |
|
产品基本信息 |
|
|
productId |
number |
产品id |
|
|
productName |
String |
产品名称 |
|
|
departCityName |
String |
出发城市 |
|
|
destinationCityNameList |
List<String> |
目的地城市 |
|
|
travelDays |
number |
出游天数 |
|
|
advanceDay |
number |
提前预定天数 |
|
|
advanceTime |
number |
提前预定小时 |
|
|
salesStartDate |
string |
销售起始日期 |
|
|
salesEndDate |
string |
销售结束日期 |
|
|
productPatternName |
number |
产品形态名称 |
|
121-机+酒;281-包价自由行; 126-机+X;161-团队游 |
pagination |
|
分页信息 |
|
|
currentPage |
number |
当前页数 |
|
|
pageSize |
number |
每页展示条数 |
|
|
totalCount |
number |
总条数 |
|
|
功能描述 |
查询单个产品详情描述 |
|||
接口名称 |
product.queryProductDescription |
|||
接口版本 |
2.0 |
|||
请求方式 |
post |
|||
请求格式 |
json |
|||
请求参数 |
QueryProductRequest |
|||
名称 |
类型 |
中文名 |
是否必填 |
备注 |
入参对象 |
必输 |
productId必输 |
||
productId |
number |
春秋产品id |
可选 |
|
productAttribute |
number |
产品属性 |
必输 |
7团队游 13 自由行 |
productName |
String |
产品名称 |
可选 |
|
systemType |
number |
系统类型 |
必输 |
0国内 1出境 |
days |
number |
天数 |
可选 |
|
departCityId |
number |
出发地 |
可选 |
|
destinationCityId |
number |
目的地 |
可选 |
|
ticketCategoryId |
number |
资源id |
可选 |
|
ticketCategoryName |
String |
资源名称 |
可选 |
|
基本参数 |
|
|||
名称 |
类型 |
备注 |
|
|
successful |
boolean |
true 成功 false 失败 |
|
|
errorResponse |
string |
错误详情 |
|
|
successResponse |
string |
|
|
|
productId |
number |
产品id |
|
|
productRecommend |
String |
经理推荐 |
|
|
productFeatures |
String |
产品特色 |
|
|
discountIntroduction |
String |
优惠说明 |
|
|
productJourneyList |
|
每日行程描述 |
团队游专用 |
|
dayOfTrip |
String |
天数 |
|
|
theme |
String |
行程主题 |
|
|
description |
String |
行程描述 |
|
|
cityName |
String |
留宿城市 |
|
|
traffic |
String |
交通 |
|
|
hotel |
String |
酒店住宿 |
|
|
food |
String |
餐饮 |
|
|
shopping |
String |
购物 |
|
|
entertainments |
String |
娱乐 |
|
|
productBookingNotice |
|
产品预定须知 |
|
|
warmTips |
string |
温馨提示 |
|
|
importantProvisions |
String |
重要条款 |
|
|
supplementaryArticle |
String |
补充条款 |
|
|
travelAlert |
String |
出行警示 |
|
|
feeNotice |
|
费用说明 |
|
|
feeInclude |
string |
费用包含 |
|
|
feeUninclude |
String |
费用不含 |
|
|
specialPrice |
String |
特殊价格说明 |
|
|
giftItems |
String |
赠送项目 |
|
|
iffoRs |
|
供应标准 |
|
|
food |
string |
用餐 |
|
|
traffic |
String |
交通 |
|
|
hotel |
String |
住宿 |
|
|
tourGuide |
String |
导游 |
|
|
ticket |
string |
门票 |
|
|
insurance |
string |
保险 |
|
|
specialService |
string |
特殊服务 |
|
|
功能描述 |
查询单个产品班期 |
|||
接口名称 |
product.queryProductSchedule |
|||
接口版本 |
2.0 |
|||
请求方式 |
post |
|||
请求格式 |
json |
|||
请求参数 |
QueryProductRequest |
|||
名称 |
类型 |
中文名 |
是否必填 |
备注 |
入参对象 |
必输 |
productId必输 |
||
productId |
number |
春秋产品id |
可选 |
|
productAttribute |
number |
产品属性 |
必输 |
7团队游 13 自由行 |
productName |
String |
产品名称 |
可选 |
|
systemType |
number |
系统类型 |
必输 |
0国内 1出境 |
days |
number |
天数 |
可选 |
|
departCityId |
number |
出发地 |
可选 |
|
destinationCityId |
number |
目的地 |
可选 |
|
ticketCategoryId |
number |
资源id |
可选 |
|
ticketCategoryName |
String |
资源名称 |
可选 |
|
基本参数 |
|
|
名称 |
类型 |
备注 |
successful |
boolean |
true 成功 false 失败 |
errorResponse |
string |
错误详情 |
successResponse |
string |
|
day |
string |
班期 |
adultPrice |
number |
成人价 |
childPrice |
number |
儿童价 |
babyPrice |
number |
婴儿价 |
roomPrice |
number |
单房差 |
inventory |
number |
库存 |
scheduleId |
number |
班期id |
功能描述 |
产品下单 |
|||
接口名称 |
grouptour.book |
|||
接口版本 |
2.0 |
|||
请求方式 |
post |
|||
请求格式 |
json |
|||
请求参数 |
GroupTourItemBookRequest |
|||
名称 |
类型 |
中文名 |
是否必填 |
备注 |
groupTourItemBook |
入参对象 |
必输 |
|
|
productId |
number |
春秋产品id |
必输 |
|
tripDate |
String |
出游时间 |
必输 |
日期格式(yyyy-MM-dd) |
orderMemo |
String |
订单备注 |
可选` |
|
num |
number |
预定分数 |
必输 |
|
contacts |
联系人 |
必输 |
|
|
name |
String |
姓名 |
必输 |
|
phone |
String |
手机号码 |
必输 |
|
cardType |
Number |
证件类型 |
可选 |
参考枚举DocumentType |
cardNo |
String |
证件号 |
可选 |
|
sex |
Number |
性别 |
可选 |
性别 0 女 1 男 |
birthDay |
String |
出生日期 |
可选 |
日期格式(yyyy-mm-dd) |
|
String |
邮件 |
可选 |
|
adultNum |
number |
成人数 |
必输 |
如无 填 0 |
childNum |
number |
儿童数 |
必输 |
如无 填 0 |
babyNum |
number |
婴儿数 |
必输 |
如无 填 0 |
roomNum
|
number |
单房差 |
必输 |
|
external_orderId |
number |
外部订单号 |
必输 |
|
external_totalAmount |
number |
外部订单金额 |
必输 |
至多两位小数 |
基本参数 |
GroupTourItemBookResponse |
|
名称 |
类型 |
备注 |
successful |
boolean |
true 成功 false 失败 |
errorResponse |
String |
错误详情 |
successResponse |
订单详情 |
|
createTime |
number |
订单创建时间 |
invalidTime |
number |
订单失效时间 |
orderId |
number |
春秋订单号 |
功能描述 |
订单取消、支付 |
|||
接口名称 |
order.statusChange |
|||
接口版本 |
1.0 |
|||
请求方式 |
post |
|||
请求格式 |
json |
|||
请求参数 |
OrderStatusChangeRequest |
|||
名称 |
类型 |
中文名 |
是否必填 |
备注 |
orderStatusChange |
入参 |
必输 |
|
|
external_orderId |
number |
外部订单号 |
必填 |
|
orderId |
number |
春秋订单号 |
必填 |
|
memo |
String |
备注 |
可选 |
|
status |
number |
状态 |
必填 |
1 取消 2 支付 |
基本参数 |
CommonResponse |
|
名称 |
类型 |
备注 |
code |
String |
0 表示成功;其他值则表示失败 |
messageText |
String |
更改订单状态成功 |
对象名称 |
DocumentType |
||
枚举名称 |
枚举值 |
是否默认 |
说明 |
ID_CARD |
1 |
默认 |
身份证 |
PASSPORT |
2 |
|
护照 |
TAIWAN_COMPATRIOT |
3 |
|
台胞证 |
MILITARY_ID |
4 |
|
军人证 |
HOUSEHOLDER_REGISTER |
5 |
|
户口本 |
POLICE_CARD |
6 |
|
警官证 |
SOLIDER_CARD |
9 |
|
士兵证 |
HOME_RETURN_PERMIT |
10 |
|
回乡证 |
MAINLAND_PASSPORT |
13 |
|
港澳通行证 |
MAINLAND_TRAVEL_PERMIT |
17 |
|
大陆通行证(国内航线) |
MAINLAND_TRAVEL_PERMIT_FOREIGN |
19 |
|
大陆居民往来台湾通行证 |