TicketInfoV52
V5.2版本的门票列表和门票详情。 主要用于支持小程序。但也可以被代理商直接调用。
TicketActivateV52
门票/年卡激活专用的WEBAPI接口,用于各代理商使用该接口对特定的门票(年卡)执行激活操作。
| API | Description |
|---|---|
| POST api/Ticket/V52/FimalyCardOrFamilyTicket/Activate |
激活一个景区门票时使用的API。 仅适应于“延迟激活”的门票。 errcode=0表示成功,tag表示具体的激活结果(返回值,激活的结果,‘1’表示已激活,‘2’表示已超过激活期限,不能再次激活,3门票已被激活,无须再次激活。0没有激活,‘4’指定的门票账户不存在,不需要执行活操作,‘5’当前门票不是可以延迟激活的门票,无需执行激活,‘6’没有找到对应的门票销售记录,不需要执行激活)。 |
SeatArea
获取某个场次可以选座的座位区域列表及座位区域的余票数 此API存在于V2.0-V4.0版本。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QuerySeatAreaList.aspx
| API | Description |
|---|---|
| GET api/SeatArea?senceid={senceid}&triplebillid={triplebillid} |
获取场次的座位区域列表及座位区域的空余座位数。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/SeatArea/Name/{seatareaid} |
获取某个座位区域的名称。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/V5/SeatArea?tickettypeid={tickettypeid}&sceneid={sceneid} |
V5版获取座位信息接口 |
GuiderLogin
导游用户登陆的控制器。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。
| API | Description |
|---|---|
| POST api/Guider/Login/WithVerifycode |
导游使用手机号+手机验证码登陆,(可选)同时绑定OPENID的API。 |
| POST api/Guider/Login/WithPassword |
导游使用用户名和密码进行登陆的API,(可选)同时绑定OPENID的API。 |
| POST api/Guider/ResetPassword/WithCode |
导游重置密码 |
| GET api/Guider/Login/WithCode?code={code} |
导游依据code登陆 |
| GET api/Guider/GetOpenId/WithCode?code={code} |
依据code获取OPENID |
TheatreProducts
获取演艺剧场产品(门票)列表。 此API存在于V2.0-V4.0所有版本。 为向下兼容,同功能的WebForms接口访问地址为~/Source/GetProducts2.aspx
| API | Description |
|---|---|
| POST api/Products2?startdate={startdate}&enddate={enddate}&seatareaid={seatareaid}&theatreid={theatreid}&senceid={senceid}&tripbillcode={tripbillcode} |
获取演艺剧场产品(门票)列表。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
OrderRefundRequest
退票办理。 V4.0 为向下兼容,同功能的WebForms接口访问地址为~/Source/RefundTicket.aspx。
| API | Description |
|---|---|
| POST api/Order/Refund |
申请退款(仅当订单处于支付完成,但因门票系统原因没有生成对应的过闸凭证时可以调用(订单此时处于“已支付”,“预订金支付授权”,“返款余额支付授权状态”,一般都用不上这个功能),绝大多数情况下,需要调用RefundTicket接口,办理退票),此操作为不可逆操作。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
YearCardScenicSpotProducts
从景区获取可以预定的年卡产品列表 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
| API | Description |
|---|---|
| GET api/YearCard/Products?startdate={startdate}&enddate={enddate} |
从景区获取可以预定的年卡产品列表 |
| GET api/YearCard/Products/ContainBuyNotice?startdate={startdate}&enddate={enddate} |
从景区获取可以预定的年卡产品列表 |
GlobalSetting
获取全局参数取值的控制器
| API | Description |
|---|---|
| GET api/GetGlobalSetting?paramName={paramName} |
获取系统全局参数的取值 |
| GET api/Report/GetRefundTime |
获取最后退票时间 |
SeatRow
查询某个座位区域的座位行和座位。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
| API | Description |
|---|---|
| GET api/Seats?seatareaid={seatareaid} |
查询某个座位区域的座位行和座位。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryRowsAndSeatsList.aspx。 |
| GET api/Seats/{seatareaid} |
查询某个座位区域的座位行和座位。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryRowsAndSeatsList.aspx。 |
AgentTeamManage
代理商团队管理相关API
ForMicroAppV52
专门小程序设计的景区基本信息获取的V5.2版本的API(不限制OTA的调用访问)。 本API主要用于获取景区的清单,各景区下销售的票型的概要清单(仅包含少量的数据,不包含票型的详细信息),用于在展示小程序上的景区页、景区下的票型列表页使用。 所有V5.2的操作接口是可以与V5.0的操作接口互操作的。
| API | Description |
|---|---|
| GET api/Setting/TouristDestination/Resouce/All/V52 |
V5.2版本检索小程序首页(不区分特定景区【全部】)的显示资源。 查询需要展示的景区/演出剧目的简要列表,用于在小程序的首页展示所有可能销售产品的旅游目的地清单。 这个版本的接口因为完全支持延迟激活(去掉了票和年卡、普通认证和人脸认证的购票过程差异)、延迟选座(去掉了普通景区票和演艺座位票的购票过程差异),已不再需要支持相互独立的景区/演出接口。因此所有的目的地(景区/园区/演出剧目)均会返回。 返回目的地数据的条件:(1)在营销管理中,对应的园区是启用的;(2)对应的园区在当前代理商授权名下未来30天有一种一上可售票型;(3)如果是演出,则必须为当前园区有绑定的且可用的剧目。 |
| GET api/Setting/TouristDestination/Resouce/Activitys/V52 |
查询供应商当前正在执行的活动的清单。这个清单包含了展示的活动的内容,本接口是不需要被OTA调用,仅用于V5.2版本以后的小程序。 |
| GET api/Setting/MicroApp/ScanIdCard/ConfigGet/V52 |
获取启用证件扫描插件的配置参数 |
| GET api/Setting/MicroApp/AllowInput/GetConfig/V52 |
获取小程序年卡绑定界面是否允许输入证件号和姓名的配置参数 |
| GET api/Setting/MicroApp/FirstPageTopShow/GetConfig/V52 |
获取小程序首页顶部菜单显示的配置,取值为YES时,若在途活动存在且只有一个时,顶部菜单栏隐藏,且只展示该活动 NO时顶部菜单栏不会隐藏 |
| GET api/Setting/MicroApp/ShowTicketContent/GetConfig/V52 |
获取小程序票型列表页服务内容等的展示配置 YES-展示 NO-不展示 |
| GET api/Setting/MicroApp/IsEnableReal/GetConfig/V52 |
获取小程序开票界面是否展示‘依据实名信息查询’展示配置 YES-展示 NO-不展示 |
| GET api/Setting/MicroApp/Activity/V52 |
获取启用且在有效期内的活动列表 |
| GET api/Setting/MicroApp/ActivityDetail/V52?activityid={activityid} |
获取活动详情列表 |
PayOrder
对订单执行预订金支付或返款余额支付的函数集。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 包括“使用预订金+支付密码进行支付”、“使用预订金+验证码进行支付”、“使用返款余额+验证码进行支付”、“使用返款余额+支付密码”进行支付四个功能。 当前接口的功能均有向下兼容(Web窗体aspx(V3.3及以前版本))的接口。
| API | Description |
|---|---|
| POST api/PayOrder/UsePrepaymentAndPassword |
使用预订金+支付密码对订单执行支付。 向下兼容,同功能的WebForms接口访问地址为~/Source/UseAccountToPayByPwd.aspx。 |
| POST api/PayOrder/MIN/UsePrepaymentAndPassword |
使用预订金+支付密码对订单执行支付。 向下兼容,同功能的WebForms接口访问地址为~/Source/UseAccountToPayByPwd.aspx。 |
| POST api/PayOrder/UsePrepaymentAndVerifyCode |
使用预付款和手机验证码支付订单。 向下兼容,同功能的WebForms接口访问地址为~/Source/UseAccountToPayByPwd.aspx。 |
| POST api/PayOrder/UseRebateAndPassword |
使用支付密码+返款余额对订单进行支付。 向下兼容,同功能的WebForms接口访问地址为~/Source/seAccountToPayByFKWithPwd.aspx。 |
| POST api/PayOrder/MIN/UseRebateAndPassword |
使用支付密码+返款余额对订单进行支付。 向下兼容,同功能的WebForms接口访问地址为~/Source/seAccountToPayByFKWithPwd.aspx。 |
| POST api/PayOrder/UseRebateAndVerifyCode |
使用返款账户余额和手机验证码支付订单 向下兼容,同功能WebForms接口为。 |
OrderAddSecnicSpot
添加一个景区类产品订单时使用的API(不论是否分时段,都使用这个API),当前API仅会往供应商处添加一个处于“预订中”的订单,这个订单受全局参数“订单支付时限”的限制,若超过了订单支付时间,订单会被自动关闭。如果您是一个OTA或通过自动机对接的代理商,推荐您使用“预订并支付”的接口(如“OrderAndPay/WithPrepayment”)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
| API | Description |
|---|---|
| POST api/Order/AddOrder |
对景区类供应商发起预订的接口(包括分时段和不分时段的模式)。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderProducts.aspx |
| POST api/Order/AddOrder/ForMiniProgram |
对景区类供应商发起预订的接口(包括分时段和不分时段的模式)。这个方法里使用了自动优惠减免,专用于小程序下单使用 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderProducts.aspx |
JDRefundComplete
京东文旅游平台已退款消息API入口。
| API | Description |
|---|---|
| POST api/SpecialOta/JD/refundCompleted |
京东文旅游平台已退款消息API入口。 调用场景:京东完成退款后主动通知商家,可用于京东运营主动退款,以及商家不走退款审核接口; 接口被调用方:供应商; 请求类型:post; 接口路径:/refundCompleted; |
MiniProgramTax
小程序、订票站点发票开具相关API
| API | Description |
|---|---|
| GET api/Setting/GetInvoiceConfig |
获取是否开启了电子发票功能(用于小程序) |
| POST api/Setting/Tax/GetOrderList |
获取需要开票的订单信息列表,小程序和订票站点均可调用 |
| POST api/Setting/Tax/RunningTask/Add |
添加一个在途开票任务 |
| POST api/Setting/Tax/GetOrderList/ByNumber |
获取需要开票的订单信息列表 |
| GET api/Setting/Tax/GetRunningRecords/NoPageCount?guidernum={guidernum}&memberid={memberid}&pageindex={pageindex}&pagesize={pagesize}&startdate={startdate}&enddate={enddate} |
查询在途开票记录 |
| GET api/Setting/Tax/GetHistoryRecords/NoPageCount?guidernum={guidernum}&memberid={memberid}&pageindex={pageindex}&pagesize={pagesize}&startdate={startdate}&enddate={enddate} |
查询历史开票记录 |
| POST api/Setting/Tax/RunningTask/Cancel |
取消一个在途开票任务 |
| GET api/Setting/Tax/CheckBill?billnum={billnum}&requesttime={requesttime} |
检查当前订单能否开具发票 |
| POST api/Setting/Tax/SendInvoice/Again |
重新推送电子发票 |
| GET api/Setting/GetIsEnableScanConfig |
获取是否启用游客扫过闸码开票功能 |
| GET api/Setting/GetOpenETicketInvoice |
获取是否开启了电子发票功能(用于代理商站点) |
ScenicSpotForMicroApp
为小程序设计的景区基本信息获取的API。这个API需要HAWK认证才能使用。 如果是代理商,使用代理商的HAWK凭据,如果是导游,使用导游的凭据。
YearCardOrderQuery
查询年卡订单的API接口(供应商调用这个接口对数据进行查询)。 查询年卡订单详细信息,查询订单主记录,查询订单明细记录,查询订单违约手续费,查询订单列表,查询订单手续费、退款列表等。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
BeginToPayWithValueCard
对某个订单进行储值卡支付。
| API | Description |
|---|---|
| POST api/Order/BeginToPay/ValueCard/MinProgram |
小程序购票时的储值卡支付 |
| POST api/Order/YearCard/BeginToPay/ValueCard/MinProgram |
小程序购买年卡时的储值卡支付 |
YearCardOrderAddSecnicSpot
添加一个景区类年卡产品订单时使用的API 当前API仅会往供应商处添加一个处于“预订中”的订单,这个订单受全局参数“订单支付时限”的限制,若超过了订单支付时间,订单会被自动关闭。如果您是一个OTA或通过自动机对接的代理商,推荐您使用“预订并支付”的接口(如“OrderAndPay/WithPrepayment”)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
YearCardOrderRefundRequest
退票办理。
| API | Description |
|---|---|
| POST api/Order/YearCard/Refund |
申请退款(仅当订单处于支付完成,但因门票系统原因没有生成对应的过闸凭证时可以调用(订单此时处于“已支付”,“预订金支付授权”,“返款余额支付授权状态”,一般都用不上这个功能),绝大多数情况下,需要调用RefundTicket接口,办理退票),此操作为不可逆操作。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
OrderQuery
查询订单的API接口(不论是景区类供应商,还是演出剧场类供应商,都是调用这个接口对数据进行查询)。 查询订单详细信息,查询订单主记录,查询订单明细记录,查询订单违约手续费,查询订单列表,查询订单手续费、退款列表等。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 此API存在于V1.0-V4.0所有版本。
Sence
获取近期场次安排及各场次的空余座位情况。 此API存在于V2.0-V4.0版本。 为向下兼容,同功能的WebForms接口访问地址为Source/QueryTheaterSenceList.aspx
| API | Description |
|---|---|
| GET api/SenceList?theatreid={theatreid}&startdate={startdate}&enddate={enddate}&theatricalid={theatricalid} |
获取近期场次安排及各场次的空余座位情况。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/QuerySenceById?senceid={senceid} |
获取某个场次安排及各场次的空余座位情况。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/SenceList/{senceid} |
获取某个场次安排及各场次的空余座位情况。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/V5/SenceList?tickettypeid={tickettypeid}&ticketdate={ticketdate} |
V5版获取座位场次信息 |
AgentGuider
代理商导游管理
JDAddOrder
专用于京东文旅下单的API。
| API | Description |
|---|---|
| POST api/SpecialOta/JD/createOrder |
京东专用API,用于提交订单第一步:CreateOrder |
GuiderRegist
导游进行注册的控制器。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。
| API | Description |
|---|---|
| POST api/Guider/Regist/WithVerifyCode |
注册一个新的导游。此操作将验证导游是否已注过册。 |
| POST api/Guider/Regist/WithVerifyCode/{guidernumber} |
注册一个新的导游。此操作将验证导游是否已注过册。 |
Guider
导游控制器。
| API | Description |
|---|---|
| POST api/Guider/Change/Mobile |
修改导游手机号码 |
| GET api/Guider/Change/QueryGuiderInfoByNumber?guidernumber={guidernumber} |
查询导游信息 |
| GET api/MiniprogramGuider/TravelerAgencyList/Get?dwlx={dwlx}&khmc={khmc}&khjc={khjc} |
获取客户单位列表 |
| GET api/MiniprogramGuider/TravelerDepartmentList/Get?dwlx={dwlx}&khmc={khmc}&khjc={khjc} |
获取部门列表 |
| GET api/MiniprogramGuider/FriendsGuider/Get |
获取好友导游列表 |
| GET api/MiniprogramGuider/ExceptFriendGuider/Get?str={str} |
获取除当前导游的好友导游外的导游列表 |
| POST api/MiniprogramGuider/FriendsGuider/Add |
添加一个好友导游 |
| POST api/MiniprogramGuider/FriendsGuider/Delete |
删除一个好友导游 |
| POST api/MiniprogramGuider/AgentGuider/Delete |
删除一个旅行社/部门下的导游 |
| POST api/MiniprogramGuider/AgentGuider/Add |
添加一个旅行社/部门下的导游 |
| POST api/MiniprogramGuider/Guider/DisBindWechat |
导游解绑微信 |
| GET api/Guider/GetGuiderInfo?guidernumber={guidernumber}&mobile={mobile} |
依据导游证号和手机号码获取导游信息 |
| POST api/Guider/RegistInfo/Edit |
编辑注册信息,只能编辑未处于“审核通过”状态的导游信息 |
YearCardOrderCancel
年卡取消订单的API接口(供应商可以使用这个接口取消处于“预订中”的年卡订单)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))
| API | Description |
|---|---|
| POST api/Order/YearCard/CancelOrder?orderid={orderid} |
取消预订单(发起预订后,以任何形式完成支付前,订单处于预订中状态,可以使用此接口撤消订单)。 |
TheatreProductsV5
V5版中,查询场次、座位等数据的API。
| API | Description |
|---|---|
| GET api/Products/V5/Theatre/Sence/ByTicketIdAndTicketDate?tickettypeid={tickettypeid}&ticketdate={ticketdate} |
依据票型ID,门票日期,查询可以选择的场次的清单并返回。 |
| GET api/Products/V5/Theatre/SeatArea/ByTicketIdAndSceneId/{tickettypeid}/{sceneid} |
依据票型ID,场次ID,查询各座位区域的名称及余票数。 |
GuiderBeforeRegist
导游注册前验证导游证号时使用的控制器。
| API | Description |
|---|---|
| GET api/Guider/Regist/VerifyGuiderNumber/{guidernumber} |
验证当前导游证号是否已注册,如果已注册,直接返回。 有以下几种情形:(1)如果有一个导游(导游证号相同),是启用的,在申请中或者是已审核 ,则将返回这个导游的信息,返回值为1。 (2)如果完全没有这个导游的信息,则返回-1 (3)如果有这个导游的信息,但没有手机号码,则返回0,表示需要验证手机验证码,并进行注册。 因此,前台注册前,输入导游证号之后、手机号之后,发送验证码之前,必须调用这个存储过程,进行验证,如果返回值为1,则不能重复进行注册,要跳转到登陆的界面。 注意,这个API的返回值将不会返回密码。 |
TeamManage
导游计调小程序团队管理相关内容
AgentLoginFromOffcialSite
通过官方网站对代理商用户进行嵌套登陆,获取代理商会话所需的KEY。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。
| API | Description |
|---|---|
| POST api/Agent/LoginFromOffcialSite |
通过官方网站对代理商用户进行嵌套登陆,获取代理商会话所需的KEY。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。 |
| POST api/Agent/LoginFromOffcialSiteMin |
通过官方网站对代理商用户进行嵌套登陆,获取代理商会话所需的KEY。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。 |
Qyt
从全域通服务器获取一个已下载的行程单
| API | Description |
|---|---|
| POST api/TripBill/{billid} |
从服务器获取一个已下载的行程单 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/GetJGJGList |
获取团队行程单的“监管机构”。 监管机构是指由旅游局认定的“团队行程单”授出机构,一般是各地或各省的旅游局。 以下面所示例的形式返回:“qyt:张家界市旅游局|yct:湖南省旅游局”。 |
| POST api/TripBill?billid={billid}&stroketype={stroketype}®istrationtype={registrationtype}&teamnumber={teamnumber}&code={code} |
从一程通同步一个行程单的信息 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
WeChatAppletLogin
微信小程序登录或注册
| API | Description |
|---|---|
| POST api/V5/WeChatAppletLogin?code={code} |
微信小程序登录 |
| POST api/Personal/Login/NONSTD/XYB/WithOpenId |
个人用户使用湘易办OPENID登陆,如果当前OpenId没有注册,则直接完成注册。 本API是一个非标API,仅用于湘易办的鉴权之后的操作。 本API返回的个人用户登陆信息与微信等是相同的,后续的处理可以是相同的。 本API返回时,Agent相关的参数全部为空,因为永远是“直客”,不存在绑定的客户单位一说。 |
| POST api/V5/WeChatAppletLoginByUnionId?code={code}&type={type} |
微信小程序登录 |
| GET api/V5/DecryptSensitiveData?sessionKey={sessionKey}&encryptedData={encryptedData}&iv={iv} |
解密微信对称加密数据,获取用户联合运营编号 |
OrderInfoV52
预订单信息相关API
DYOrder
抖单下单操作的API。
| API | Description |
|---|---|
| POST api/SpecialOta/DouYin/CalendarTicket/Order/Verify |
下单前的校验接口,用于消费者预订前的信息校验,包括库存和限购规则等,保障消费者提交订单后不会因为库存不足或其他业务规则被拒单。 V5及V5以前的版本。 对V53版本添加的整团入园和保险赋值设置默认值。 |
| POST api/SpecialOta/DouYin/NotifyRefundInfo |
将第三方(抖音)的退款数据存入数据库。 这个有可能是单方面退款,因此只能保存。 |
YearCardFaceImage
年卡图片
| API | Description |
|---|---|
| POST api/WebInterface/Order/YearCard/Ticket/FaceImage/Cut |
客人在手机上拍照,图片发往百度验证完成之后,调用本方法进行切图。 切图的过程会将原来发往百度验证的图片缩放并切片成标准图片。 |
| POST api/WebInterface/Order/YearCard/Ticket/FaceImage/Add |
插入指定内部识别号的一条生物特征记录 |
| GET api/WebInterface/Order/YearCard/Ticket/FaceImage/Query?lbsbh={lbsbh} |
查询指定内部识别号的一条生物特征记录 |
BeginToPayWithJsapi
在微信公众号里面,使用微信JSAPI支付时,调用这个接口。HAWK认证。
| API | Description |
|---|---|
| GET api/Order/PayModel/Get |
获取支付方式 |
| POST api/Order/BeginToPay/Jsapi |
使用JSAPI支付的代码 |
| POST api/Order/BeginToPay/MinProgramPayByPersionId |
小程序支付---使用个人用户名提交,规避openid存储在客户端 |
| POST api/Order/BeginToPay/MinProgram |
小程序支付 |
| POST api/Order/BeginToPay/MinProgram/ForAbcCS |
小程序支付,农行创识接口 |
| POST api/Order/BeginToPay/MinProgram/HNXFT |
在小程序中,使用湖南星富通支付(澧县农商银行),使用这个接口。 |
| POST api/Order/BeginToPay/MinProgram/ForKouDaiLQ |
小程序支付,口袋零钱接口 |
| POST api/Order/BeginToPay/MinProgram/ForYYRCB |
小程序支付,酉阳农商行接口 |
| POST api/Order/BeginToPay/ABCJsapi |
农行微信支付使用JSAPI支付的代码 |
| POST api/BeginToPayWithJsapi |
0元票直接完成订单的接口 |
ProductsQueryV52
V5.2版本接口(本版本接口升级于2024年5月,只是部分更新,可以与原V5版本接口、V3版本接口互操作)。 本版本的本接口主要用于查询更为详情的产品信息,包括“是否可以支持延迟激活”,“是否可以支持延迟选座”,“认证方式”,“包含的消费项目”等。用于各OTA、代理商及小程序更好地获取信息并开展业务。
MeiTuan
专用于美团对接使用的API,代理商也可以根据需要调用。
| API | Description |
|---|---|
| GET api/SpecialOta/Meituan/GetOrderInfo?orderid={orderid}&senderid={senderid} |
获取美团的订单信息,用于在美团的“支付”回调中给美团返回数据。 |
TicketImage
获取手机二维码门票(这个图片可以在闸机、手持机上检票)的图片。
| API | Description |
|---|---|
| GET api/Ticket/Image/Direct/{orderid}/{ticketcode} |
获取手机二维码门票的图片(这个图片在手机上显示之后,可以直接用于检票)。 本API将较验访问者对订单的访问权限,不要求执行前置的api/Order/QueryWJM获取文件名。 本API是实时API,订单一支付可立即调用。 本方法与api/Ticket/Image/{orderid}/{ticketcode}的不同之处在于,返回的内容直接是一个图片,类似于www.xxxx.com/xxxx.jpg访问一个jpg文件时的返回。 |
| GET api/Ticket/Image/{orderid}/{ticketcode} |
获取手机二维码门票的图片(这个图片在手机上显示之后,可以直接用于检票)。 本API将较验访问者对订单的访问权限,不要求执行前置的api/Order/QueryWJM获取文件名。 本API是实时API,订单一支付可立即调用。 |
| GET api/Ticket/Barcode/String/{orderid}/{ticketcode} |
获取门票二维码二维码字符串。 本API将较验访问者对订单的访问权限,不要求执行前置的api/Order/QueryWJM获取文件名。 本API是实时API,订单一支付可立即调用。 |
| GET api/Ticket/Resource/String/{ticketcode} |
获取门票二维码字符串(此处ticketcode门票对应的FILECODE码,该码通过api/Order/QueryWJM获取)。 |
| GET api/Ticket/Resource/{ticketcode} |
获取门票图片(此处对应的FILECODE码,该码通过api/Order/QueryWJM获取。) |
| GET api/Ticket/Resource/V4/{ticketcode} |
获取门票图片(此处对应的FILECODE码,该码通过api/Order/QueryWJM获取。),返回的是动态码,有过期时间 |
Theatrical
获取当前正在演出(排片)剧目列表(影片列表)。 在V4.0新增。 没有对应的WEBForms接口。
| API | Description |
|---|---|
| GET api/Theatrical |
获取当前正在演出(排片)剧目列表(影片列表)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/V5/Theatrical?theatricalid={theatricalid} |
获取当前正在演出(排片)剧目列表(影片列表)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| POST api/Theatrical?theatricalid={theatricalid} |
获取指定代码的剧目(影片)信息。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| POST api/Theatrical/{theatricalid} |
获取指定代码的剧目(影片)信息。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
Rpt_Web_Yd
互联网报表
Rebate
返款余额账户API,可以使用这一组API查询当前代理商的返款账户余额及明细。
| API | Description |
|---|---|
| GET api/Agent/Rebate?year={year} |
返回返款账户的信息,因返款账户总是以年度为单位组织,因此会返回一个集合。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryFKRec.aspx。 |
| GET api/Agent/Rebate/TradeRecords?startdate={startdate}&pageindex={pageindex}&year={year}&enddate={enddate}&tradetype={tradetype} |
查询返款账户交易记录。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryFKJYRec.aspx。 |
AgentConfig
获取供应商参数、设置供应商处的参数。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 当前接口的功能均有向下兼容(Web窗体aspx(V3.3及以前版本))的接口。
| API | Description |
|---|---|
| GET api/ProviderConfig |
获取供应商参数设置。 向下兼容,同功能的WebForms接口访问地址为Source/GetProviderConfig.aspx。 |
| POST api/ProviderConfig |
设置供应商处的参数。 向下兼容,同功能的WebForms接口访问地址为Source/SetAgentParameters.aspx。 |
| GET api/JQ/Get/Name |
获取景区名称 |
Login
个人用户登陆操作(包括使用用户名+密码、手机号+验证码等方式)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))(这个使用的是特定用户,代理商无法访问)。
| API | Description |
|---|---|
| POST api/Personal/Login/WithUserName |
个人用户使用用户名和密码登陆。 |
| POST api/Personal/Login/WithOpenId |
个人用户使用微信OPENID登陆,如果当前OpenId没有注册,则直接完成注册。 |
| POST api/Personal/Login/WithVerifyCode |
个人用户使用手机号+验证码登陆,如果尚未注册,则直接注册。 |
PosInfoQuery
自营零售商品销售代理接口之基础信息查询API。
| API | Description |
|---|---|
| GET api/Pos/Product/ClassList/Query?levelindex={levelindex} |
获取当前旅行社互联网账户绑定的店铺在销的商品隶属的商品类别。 执行对接开发的客户应该缓存这个清单。 返回的内容是平面的,如: 000食品(一级); 000001主食(二级); 000001002 包子。 |
| GET api/Pos/Product/ClassList/Query/{levelindex} |
获取当前旅行社互联网账户绑定的店铺在销的商品隶属的商品类别。 执行对接开发的客户应该缓存这个清单。 返回的内容是平面的,如: 000食品(一级); 000001主食(二级); 000001002 包子。 |
| GET api/Pos/Product/PriceAndInventory/Query?state={state}&productclasscode={productclasscode}&keyword={keyword}&addstate={addstate} |
查询商品的清单,并以简单数据类型返回。 (主要用于在小程序上获取显示的信息)。 注意,当一个商品有多个单位可售时,可能会存在多个记录。 |
| GET api/Pos/Product/PriceAndInventory/TreeData/Query?state={state}&productclasscode={productclasscode}&keyword={keyword}&addstate={addstate} |
查询商品的清单,并以简单数据类型返回。 (主要用于在小程序上获取显示的信息)。 本返回是一个树型结构,根是“商品信息”,叶子是“当前商品在参数所指定的门店的报价和库存的信息”。 |
| GET api/Pos/Product/PriceAndInventory/Only/Query?productid={productid} |
获取某个商品的价格及库存。 |
| GET api/Pos/Product/PriceAndInventory/Only/Query/{productid} |
获取某个商品的价格及库存。 |
TicketRefundRequest
退票申请(将订单中的一个或多个门票申请退票,申请退票后,不能撤消退票申请[不可逆操作],只能等待供应商办理退款)。使用预订金支付、返款余额支付的,申请退票时将同时办结;即时支付时需等待供应商办理退款)。订单交割之后,门票已生成,若再需要退票,则必须调用这个API,而不能使用订单的退款申请。
| API | Description |
|---|---|
| POST api/Order/RefundTicket |
退票申请(将订单中的一个或多个门票申请退票,申请退票后,不能撤消退票申请[不可逆操作],只能等待供应商办理退款)。使用预订金支付、返款余额支付的,申请退票时将同时办结;即时支付时需等待供应商办理退款)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
JDTicketImage
供京东的用户查看门票图片的控制器。
| API | Description |
|---|---|
| GET api/e/{ticketcode} |
京东的专用接口,用于查看京东的门票图片。 |
JDPayOrder
专用于京东文旅支付订单的API。
| API | Description |
|---|---|
| POST api/SpecialOta/JD/payOrder |
从京东文旅平台过来的,支付订单的API入口。 |
AgentTeamMemberManage
团队成员管理(代理商站点)
| API | Description |
|---|---|
| GET api/Agent/TeamManage/TeamMember/Get?teamid={teamid}&pageindex={pageindex}&pagesize={pagesize} |
以不计页数的分页方法查询团队成员信息,以简单类型返回 |
| GET api/Agent/TeamManage/TeamMemberList/GetAll?teamid={teamid} |
获取团队成员列表 |
| GET api/Agent/TeamManage/TeamMemberList/GetAll/{teamid} |
获取团队成员列表 |
| POST api/Agent/TeamManage/TeamMember/Add |
添加团队成员 |
| POST api/Agent/TeamManage/TeamMember/AddMulti |
批量添加团队成员 |
| POST api/Agent/TeamManage/TeamMember/Edit |
编辑成员信息 |
| POST api/Agent/TeamManage/TeamMember/Delete |
删除一个团队成员信息 |
Theatre
获取系统中所有剧场列表。 此API存在于V2.0-V4.0所有版本。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryTheatreList.aspx
| API | Description |
|---|---|
| GET api/TheatreList |
获取系统中所有剧场列表。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/TheatreList?theatreid={theatreid} |
获取系统中指定ID的剧场。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/TheatreList/{theatreid} |
获取系统中指定ID的剧场。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
BaiduFaceRecognition
调用百度人脸识别的API对采集到的人脸进行识别比对
| API | Description |
|---|---|
| POST api/Baidu/FaceRecognition/Distinguish |
判断图片中的人脸数及是否为人脸 |
| POST api/Baidu/FaceRecognition/Compare |
判断再次录入的照片人脸是否与已存在的为同一人 |
| GET api/Baidu/FaceRecognition/Obtain/Token |
获取百度API的token,注意:该token有效期为一个月,建议每次请求时都拉取一次 |
TicketListV5
V5版本的门票列表和门票详情。 主要用于支持小程序。但也可以被代理商直接调用。
Banner
小程序Banner页相关API。
| API | Description |
|---|---|
| GET api/BannerInfo/Get |
获取状态为启用的一个Banner页信息 |
| GET api/BannerInfo/GetUrl |
获取图片的url |
Regist
个人用户的注册操作。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))(这个使用的是特定用户,代理商无法访问)。
| API | Description |
|---|---|
| POST api/Personal/Regist |
个人用户的注册。HAWK认证,仅限官方网络,代理商不可访问。 |
| POST api/Personal/CheckUserNameUseable |
检查某个用户名是否可以用于(个人用户)注册。V4.0接口,没有向下兼容接口,HAWK认证,仅限官方网络,代理商不可访问。 |
| POST api/Personal/CheckMobileUseable |
检查某个手机号是否可以用于(个人用户)注册。V4.0接口,没有向下兼容接口,HAWK认证,仅限官方网络,代理商不可访问。 |
InfoAndPwd
个人用户查询个人信息,修改密码的API。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))(这个使用的是特定用户,代理商无法访问)。
| API | Description |
|---|---|
| GET api/Personal/Info/{username} |
依据用户名获取当前用户的一般信息,HAWK认证,仅限官方网络,代理商不可访问。 |
| GET api/Personal/InfoByid/{memberid} |
依据用户ID获取当前用户的一般信息,HAWK认证,仅限官方网络,代理商不可访问。 |
| GET api/Personal/InfoByid?memberid={memberid} |
依据用户ID获取当前用户的一般信息,HAWK认证,仅限官方网络,代理商不可访问。 |
| POST api/Personal/Login/ResetPassword |
使用手机号+验证码的模式重置个人用户密码。V4.0接口,没有向下兼容接口,HAWK认证,仅限官方网络,代理商不可访问。 |
| POST api/Personal/Login/ChangePassword |
使用旧密码更改个人用户密码。V4.0接口,没有向下兼容接口,HAWK认证,仅限官方网络,代理商不可访问。 |
| POST api/Personal/Info/ChangeMobile |
修改手机号码 |
| POST api/Personal/Info/ChangePersonalInfo |
修改手机号码 |
| GET api/V5/Miniprogram/WechatBindMobile/Get?code={code} |
向微信请求手机号 |
| POST api/V5/MiniprogramApp/UserInfo/Update |
更新个人会员的姓名和手机信息 |
| POST api/Personal/Info/HoldUserInfo |
修改持卡人信息 |
| POST api/Personal/MemeberInfo |
修改个人会员信息 |
Prepayment
预订金账户的API,可以使用这一组API查询当前代理商的预订金账户余额及明细。
| API | Description |
|---|---|
| GET api/Agent/Prepayment |
查询预订金账户余额(基本信息)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryYFKRec.aspx。 |
| GET api/Agent/Prepayment/TradeRecords?startdatetime={startdatetime}&enddatetime={enddatetime}&pageindex={pageindex}&tradetype={tradetype} |
查询预订金账户交易记录。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QueryYFKJYRec.aspx |
SeatStatus
查询某个场次、某个座位区域的座位状态,用于刷新客户端给客人展示的座位图 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QuerySeatsState.aspx。
| API | Description |
|---|---|
| GET api/Seats/Status?senceid={senceid}&seatareaid={seatareaid} |
查询某个场次、某个座位区域的座位状态,用于刷新客户端给客人展示的座位图 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QuerySeatsState.aspx。 |
| GET api/Seats/Status/{senceid}/{seatareaid} |
查询某个场次、某个座位区域的座位状态,用于刷新客户端给客人展示的座位图 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QuerySeatsState.aspx。 |
| GET api/Seats/Status/MicroApp?senceid={senceid}&seatareaid={seatareaid} |
查询某个场次、某个座位区域的座位状态,用于刷新客户端给客人展示的座位图 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/QuerySeatsState.aspx。 |
ScenicSpot
获取景区版客户端的景区介绍。 这是一个不需要授权的API。
| API | Description |
|---|---|
| GET api/GetScenicSpots |
景区版客户端获取景区介绍 |
Agent
代理商有关的接口。 包括修改密码、修改支付密码、取得验证码、从官方渠道登陆等。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。
| API | Description |
|---|---|
| POST api/Agent/ChangeLoginPassword/UseVerifyCode |
代理商(旅行社(OTA)、部门、导游)使用验证码重置登陆密码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Agent/ChangeLoginPassword/UseVerifyCodeByMIN |
代理商(旅行社(OTA)、部门、导游)使用验证码重置登陆密码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Agent/ChangeLoginPassword/UseOldPwd |
代理商使用旧密码修改登陆密码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Agent/ChangeLoginPassword/UseOldPwdByMIN |
代理商使用旧密码修改登陆密码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| GET api/Agent/Info |
获取当前代理商的信息。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Agent/CheckAccountName |
(这是一个为了兼容旧版软件提供的接口,请尽量不要使用)。 验证某个代理商的用户名是否正确,并返回相应的信息。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/V5/Agent/CheckAccountName?accountname={accountname} |
(这是一个为了兼容旧版软件提供的接口,请尽量不要使用)。 验证某个代理商的用户名是否正确,并返回相应的信息。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Agent/ChangePayPassword |
使用验证码更改支付密码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Agent/ChangePayPasswordByMIN |
使用验证码更改支付密码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
VerifyCode
与验证码有关API。
| API | Description |
|---|---|
| POST api/Personal/VerifyCode?mobile={mobile} |
给某个手机号(个人用户)发送一个验证码。 |
SendVerifyCode
给导游的手机号发送验证码的API。 使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。
| API | Description |
|---|---|
| POST api/Guider/VerifyCode/BeforeLogin/WithGuiderNumOrMobile?guidernumberormobile={guidernumberormobile} |
在登陆之前,使用导游证号或手机号给导游发送登陆验证码。 ( |
| POST api/Guider/Regist/VerifyCode?mobile={mobile} |
给某个手机号(个人用户)发送一个验证码。注册导游时需要用到。 |
YearCardBeginToPay
对某个互联网年卡预订单发起支付(仅指第三方即时支付,如支付宝、微信、银联等)。 这个接口将您的请求,依据系统中设置的收款账号等参数,编写新的请求后Redirect到支付平台。
| API | Description |
|---|---|
| POST api/YearCard/Order/BeginToPay/MinProgramPayByPersionId |
小程序支付---使用个人用户名提交,规避openid存储在客户端 |
| POST api/YearCard/Order/BeginToPay/MinProgram |
在小程序中对年卡订单进支付时起调的接口。 这个接口不支持使用优惠券。 |
| POST api/Order/YearCard/BeginToPay/MinProgram/ForAbcCS |
小程序支付,农行创识接口 |
| POST api/Order/YearCard/BeginToPay/MinProgram/ForHNXFT |
小程序年卡支付,湖南星富通支付 |
| POST api/Order/YearCard/BeginToPay/MinProgram/ForKouDaiLQ |
小程序支付,口袋零钱接口 |
| POST api/YearCard/Order/BeginToPay/MinProgram/ForCoupon |
小程序中起调微信支付对年卡订单进行支付时调用的接口。 这个接口是新版本的,支持使用“优惠券”。 |
ScenicSpotProducts
从景区获取可以预定(预购)的产品(门票)列表(包括分时段和不分时段的模式),获取产品的库存信息。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 此API存在于V1.0-V4.0所有版本。 为向下兼容,同功能的WebForms接口访问地址为~/Source/GetProducts.aspx
| API | Description |
|---|---|
| GET api/Products?startdate={startdate}&enddate={enddate}&servicecode={servicecode}&tripbillcode={tripbillcode} |
从景区获取可以预定(预购)的产品(门票)列表(包括分时段和不分时段的模式) |
| GET api/Products/Inventory?startdate={startdate}&enddate={enddate}&productid={productid}&servicecode={servicecode} |
从景区获取可以预定(预购)的产品(门票)列表(包括分时段和不分时段的模式) 为向下兼容,同功能的WebForms接口访问地址为~/Source/GetProductsInventory.aspx。 |
AgentCheckAccountFromOffcial
从官方网站,官方微信中,可以调用这个控制器的方法(使用官方用户进行签权)。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))
| API | Description |
|---|---|
| GET api/Agent/Info/FromOffcial/{username} |
在官方网站页面、官方微信页面验证某个代理商的用户名是否正确,并返回相应的信息。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=官方互联网用户名、User=官方互联网用户名、密钥=KEY+UPPER(MD5(特定登陆密码))) |
FrequentContacts
个人用户常用联系人
OrderAddV53
V53版本的API
| API | Description |
|---|---|
| POST api/Order/ScenicSpot/AddOrder/ForMiniProgram/V53InsuranceAndHoleTeamChk |
对景区类供应商发起预订的接口(包括分时段和不分时段的模式)。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderProducts.aspx。 V53版本,含有整团入园参数和购买保险参数。。 |
| POST api/Order/ScenicSpot/AddOrder/V53InsuranceAndHoleTeamChk |
对景区类供应商发起预订的接口(包括分时段和不分时段的模式)。 V53版本,含有整团入园参数和购买保险参数。。 |
| GET api/Insurance/PlanSetting/Get/ByTicketId?ticketid={ticketid} |
获取票型的保险设置 |
AgentVerifyCode
代理商用户在业务过程中,发送验证码的API接口。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。
| API | Description |
|---|---|
| POST api/Agent/VerifyCode |
代理商拥有用户名、密码、密钥的情况下,下发一个在业务过程中进行操作较验的验证码。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码))) |
OrderAndPay
对景区类供应商(含分时段和不分时段)发起预定并使用预订金或返款余额对订单执行支付。 将预订和支付封装在同一个事务中,确保同时成功或失败,是代理商接口最佳操作。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
| API | Description |
|---|---|
| POST api/OrderAndPay/WithPrepayment |
对景区类供应商发起预定(不论是否分时段均使用此API)并使用支付密码+预订金对订单执行支付。 此API相当于在同一个事务中分别调用AddOrder和UsePrepaymentWithPasswordToPay两个接口。 |
| POST api/OrderAndPay/WithPrepayment/SpecialForYouYang |
对景区类供应商发起预定(不论是否分时段均使用此API)并使用支付密码+预订金对订单执行支付。 此API相当于在同一个事务中分别调用AddOrder和UsePrepaymentWithPasswordToPay两个接口。 这是一个特殊的接口,仅用于旅行社版本系统向景区系统发起请求,这个接口可以下同时包含景区和演出门票的单 |
| POST api/OrderAndPay/WithRebate |
对景区类供应商发起预定(不论是否分时段均使用此API)并使用支付密码+返款余额对订单执行支付。 此API相当于在同一个事务中分别调用AddOrder和UseRebateWithPasswordToPay两个接口。。 |
ScenicSpotProductsV5
第五版获取景区/演出(剧场)产品及产品库存的接口。 此接口设计更为合理,内容更为明细(除N天内不能重复购票以外,其余设设置都将随同返回)。
ValueCard
小程序储值卡相关API
JDCloseOrder
京东文旅关闭订单的API。
| API | Description |
|---|---|
| POST api/SpecialOta/JD/closeOrder |
京东文旅平台过来的关闭一个订单的API的入口。 |
ShoppingCart
购物车相关的API。 此API调用时需要进行HAWK认证。
| API | Description |
|---|---|
| GET api/ShoppingCart/State?grhyid={grhyid} |
查询某个用户购物车中添加的商品种类的数量和商品的数量。 |
BeginToPay
对某个订单发起支付(仅指第三方即时支付,如支付宝、微信、银联等)。 这个接口将您的请求,依据系统中设置的收款账号等参数,编写新的请求后Redirect到支付平台。 此API存在于V1.0-V4.0版本,为向下兼容,同功能的WebForms接口访问地址为~/Source/ BeginToPay.aspx
| API | Description |
|---|---|
| POST api/Order/BeginToPay/Phone |
在手机网站或者微信公众号里对某个订单发起支付(仅指第三方即时支付,如支付宝、微信、银联等)。 注意:入口为BeginToPayPhone的仅针对手机网站调用 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 手机网站第三方支付从T_SYS_ZFQD中取值 1,支付宝手机网站参数约定:Parm1:私钥、Parm2:公钥、Parm3:Appid、SKZH不能为空 2,微信支付手机网站参数约定 |
| POST api/Order/BeginToPay |
在电脑网页上发起对某个订单发起支付(仅指第三方即时支付,如支付宝、微信、银联等)。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Order/BeginToPayNew |
在电脑网页上发起对某个订单发起支付(仅指第三方即时支付,如支付宝、微信、银联等)。 认证方式:HAWK(ID=代理商获得的用户名、User=代理商获得的用户名、密钥=KEY+UPPER(MD5(代理商登陆密码)))。 |
| POST api/Order/BeginToPay/WithAbcJLCloudPos |
开始一个农行聚合码的支付 1)调用存储过程Sp_3Pay_Offline_ReceiveMoney_Begin保存第三方支付的发起记录; (2)调用农行接口,下单并获取一个二维码; |
| POST api/Order/BeginToPay/WithKouDaiLQ |
开始一个口袋零钱的支付,码的类型由payTypeCode决定,最大长度: 30,wxPubQR:微信,alipayQR:支付宝,unionpayDynamic:云闪付,dynamicPay:微信支付宝聚合(不支持云闪付) |
| POST api/Order/BeginToPay/AliOrWechatPayH5 |
发起一个微信或支付宝H5支付 |
JDRefundOrder
京东文旅订单退款的API。
| API | Description |
|---|---|
| POST api/SpecialOta/JD/refundOrder |
京东文旅平台退单、退票时使用的API的入口。 调用场景:当用户发起退款后,京东需要向商家发起退款申请;接口需做幂等处理,如京东因网络等不确定原因重复调用的,供应商侧需返回第一次调用相同的逻辑,如退款成功,退款中,退款失败等; 接口被调用方:供应商; 请求类型:post; 接口路径:/refundOrder; |
AgentVerifyCodeFromOffcial
从官方网站,官方微信中,可以调用这个控制器的方法(使用官方用户进行签权)。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=特定用户名、User=特定用户名、密钥=KEY+UPPER(MD5(特定登陆密码)))。
| API | Description |
|---|---|
| POST api/Agent/AgentIsVerifyCode |
(这是一个为了兼容旧版软件提供的接口,请尽量不要使用) 这是一个特殊的接口,用于在官方网站、官方微信的应用程序中,给代理商留存在供应商处的手机号码发送一个验证码。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=官方互联网用户名、User=官方互联网用户名、密钥=KEY+UPPER(MD5(特定登陆密码))) |
| POST api/Agent/VerifyCode/FormOffcial |
这是一个特殊的接口,用于在官方网站、官方微信的应用程序中,给代理商留存在供应商处的手机号码发送一个验证码。 (这个使用的是特定用户,代理商无法直接访问)认证方式:HAWK(ID=官方互联网用户名、User=官方互联网用户名、密钥=KEY+UPPER(MD5(特定登陆密码))) |
MemberCoupons
小程序优惠券相关API
FamilyYearCard
直客小程序家庭年卡功能相关的API
| API | Description |
|---|---|
| POST api/Order/FamilyYearCard/AddNumber |
给家庭年卡添加成员 |
| POST api/Order/FamilyTicket/AddNumber |
给家庭年卡添加成员 |
| GET api/Order/FamilyYearCard/MaxCount/Get?billnum={billnum} |
获取某个家庭年卡/家庭票订单支持的最大凭证数量 |
| GET api/Order/FamilyYearCard/MaxCount/Get/{billnum} |
获取某个家庭年卡/家庭票订单支持的最大凭证数量 |
| GET api/Order/FamilyTicket/MaxCount/Get?billnum={billnum} |
获取某个家庭年卡/家庭票订单支持的最大凭证数量 |
| GET api/Order/FamilyTicket/MaxCount/Get/{billnum} |
获取某个家庭年卡/家庭票订单支持的最大凭证数量 |
| GET api/Order/FamilyYearCard/AllNumber/Get?lbsbh={lbsbh}&billnum={billnum} |
获取当前家庭年卡的所有成员信息 |
| GET api/Order/FamilyYearCard/AllNumber/Get/{lbsbh}/{billnum} |
获取当前家庭年卡的所有成员信息 |
| GET api/Order/FamilyTicket/AllNumber/Get?lbsbh={lbsbh}&billnum={billnum} |
获取当前家庭年卡的所有成员信息 |
| GET api/Order/FamilyTicket/AllNumber/Get/{lbsbh}/{billnum} |
获取当前家庭年卡的所有成员信息 |
| GET api/Order/FamilyYearCard/GetInfo?personalid={personalid}&name={name}&idcard={idcard} |
通过个人会员ID查询该用户办理的家庭年卡列表 |
ServiceItem
从景区类供应商获到服务项目列表(旅游线路列表)的API。 为向下兼容,同功能的WebForms接口访问地址为~/Source/GetServiceItem.aspx
| API | Description |
|---|---|
| GET api/ServiceList |
检索景区类供应商旅游线路(服务项目)清单。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
| GET api/ServiceList/{servicecode} |
检索景区类供应商指定代码的服务项目 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
YearCardV52
V5.2年卡专用扩展。
OrderAddTheatre
添加一个剧场类(为每个票分配座位)产品订单时使用的API,当前API仅会往供应商处添加一个处于“预订中”的订单,这个订单受全局参数“订单支付时限”的限制,若超过了订单支付时间,订单会被自动关闭。如果您是一个OTA或通过自动机对接的代理商,推荐您使用“预订并支付”的接口(如“OrderAndPay/WithPrepayment”)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
| API | Description |
|---|---|
| POST api/Order/AddOrder2 |
对演艺类供应商发起预订的接口。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderProducts2.aspx |
PayChannel
从电子门票系统中获取官方认可的即时支付支付渠道。 即时支付:指支付宝、微信、银联网上支付等支付渠道,它们不同于预订金、返款余额支付,由游客在下单时直接向景区指定的渠道执行支付。 此功能在代理商(OTA或旅行社)执行接口时,一般不使用。 此API存在于V1.0-V4.0版本,为向下兼容,同功能的WebForms接口访问地址为~/Source/GetPayChannel.aspx
| API | Description |
|---|---|
| GET api/PayChannel?configpaymenttype={configpaymenttype} |
从电子门票系统中获取官方认可的即时支付支付渠道。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 |
OrderAndPay2
对演艺剧场(含影院)类供应商发起预定并使用预订金或返款余额对订单执行支付。 将预订和支付封装在同一个事务中,确保同时成功或失败,是代理商接口最佳操作。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。
| API | Description |
|---|---|
| POST api/OrderAndPay2/WithPrepayment |
对演艺剧场类供应商发起预定并使用支付密码+预订金对订单执行支付。 此API相当于在同一个事务中分别调用AddOrder2和api/PayOrder/UsePrepaymentAndPassword两个接口。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderAndPayWithYDJ2.aspx。 |
| POST api/OrderAndPay2/WithRebate |
对演艺剧场类供应商发起预定并使用支付密码+预订金对订单执行支付。 此API相当于在同一个事务中分别调用AddOrder2和api/PayOrder/UseRebateAndPassword两个接口。 为向下兼容,同功能的WebForms接口访问地址为~/Source/OrderAndPayWithFK2.aspx。 |
PosSellOrRefund
POS自营零售下单,结单,退单等操作的API接口。
| API | Description |
|---|---|
| POST api/Pos/Sell/Bill/AddOrUpdate |
添加或修改一个售货单。注意,售货单仅在初始状态(任何一次付款前,才能被修改)。 提交售货单时,系统将验证其在仓库是否有记录(哪怕是库存为零),没有的不能提交; 其次将验证其在门店是否有报价;当零售价与门价当前价格不一致时,将提交失败; 将验证折后价是否低于最低零售限价,折合价低于此价格时,将提交失败。 需要判断返回值,返回值的errcode=0表示操作成功。 本操作成功后会有回调。 操作的流程是: A:下单后支付 (1)AddOrUpdate(下单) (2)PayBill(支付)。 B:下单后关闭订单: (1)AddOrUpdate(下单)。 (2)DeleteOrClose(删除或关闭订单)。 |
| POST api/Pos/Sell/Bill/Pay/WithPrepayment/ByPwd |
使用预订金支付一个自营零售的单据。 返回为0表示成功,返回为1表示以前支付过,本次并未支付,返回了单据的当前信息。返回-1表示失败。 被支付的单据必须是你本人的。 取件码会在本操作中返回。 本操作成功后可能有回调。 也可以在回调中查询取件码。 操作的流程是: (1)AddOrUpdate(下单) (2)PayBill(支付)。 |
| GET api/Pos/Sell/Bill/Query/NoPageCount/WithSimpleRet?pageindex={pageindex}&billnum={billnum}&senderbillnum={senderbillnum}&productid={productid}&guestmobile={guestmobile}&guestcericode={guestcericode}&billstate={billstate} |
以简单条件为依据,以不计页数的分页方式,查询V_Pos_Sell主表视图,并以简单类型返回。 |
| GET api/Pos/Sell/Bill/DetailInfo/Query/One/ByBillNum?billnum={billnum}&senderbillid={senderbillid} |
查询当前代理商的某个订单的详细信息,以简单类型返回,这个结果中包含主记录信息,销售明细信息,付款清单信息,导游绑定记录信息等。是一个单据的完整数据。一次总是只能查询一个订单(总是只能查询代理商的互联网订单)。 |
| POST api/Pos/Refund/AddOrUpdate |
发起一个退货请求。 每次退货总是只能针对一个售货单进行。 每次至少退原售货单的一个明细。 原售货单的每个明细总是需要在一次退货中退完。 本操作发起退货申请后,如果未取货,能直接办结;如果已取货,则需要审核才能办结。 审核的结果有两种,分别是“已办理”,“已拒绝”。拒绝表示不能退货,以上两者状态均是最终状态。 退货的申请,审核均是将会有回调的事件。 |
JDQueryOrder
从京东文旅平台过来的,查询订单信息的API入口。
| API | Description |
|---|---|
| POST api/SpecialOta/JD/queryOrder |
京东文旅订单查询API入口。 |
Rebate_GetMoneyFromWeb
返款账户余额通过互联网提现相关的API。
| API | Description |
|---|---|
| GET api/WebInterface/Account/Rebate/GetMoney/FromWeb |
获取某个账户是否可以提现,单日提现额度,已提现数等。 |
| POST api/WebInterface/Account/Rebate/GetMoney/FromWeb/AddRequest |
从互联网上(手机或网页)发起一个提现申请。 提现申请发起后,将由系统的后台服务逐一执行支付,支付的结果可以通过检索“提现申请”的受理状态获取。 |
| GET api/WebInterface/Account/Rebate/GetMoney/FromWeb/Request/Query/WithPage?startdate={startdate}&enddate={enddate}&processstatus={processstatus}&pageindex={pageindex}&pagesize={pagesize} |
查询某个账户的发起的提现申请的清单。 |
| GET api/WebInterface/Account/Rebate/GetMoney/FromWeb/Request/Query/ByBillNum?billnum={billnum}&customerid={customerid}&customertype={customertype} |
查询单个的提现申请的记录。 |
| GET api/WebInterface/Account/Rebate/GetMoney/FromWeb/Request/Query/ByBillNum/{billnum}/{customerid}/{customertype} |
查询单个的提现申请的记录。 |
| POST api/WebInterface/Account/Rebate/GetMoney/FromWeb/CancelRequest |
从互联网上撤消一个提现申请。 |
OrderCancel
取消订单的API接口(不论景区类供应商,还是剧场类供应商均可以使用这个接口取消处于“预订中”的订单)。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))
| API | Description |
|---|---|
| POST api/Order/CancelOrder |
取消预订单(发起预订后,以任何形式完成支付前,订单处于预订中状态,可以使用此接口撤消订单)。 |
TimeSegment
获取供应商电子门票时段分配表。仅在供应商启用时段设置时,此函数才可以被调用。 V4.0接口。
| API | Description |
|---|---|
| GET api/TimeSegment?startdate={startdate}&enddate={enddate}&servicecode={servicecode} |
获取供应商电子门票时段分配表。仅在供应商启用时段设置时,此函数才可以被调用。 认证方式:HAWK,密钥:KEY+UPPER(MD5(密码))。 为向下兼容,同功能的WebForms接口访问地址为~/Source/GetTimeSegment.aspx。 |