ecstore接口文档指导规则.doc

数据中心接口阐明目录数据中心接口阐明1目录1更新日记31. 祈求参数阐明31.1. 接口域名阐明31.2. format 参数阐明31.3. 接口访问权限31.3.1. pid 参数阐明31.3.2. 签名参数32. 返回数据阐明52.1. 返回数据分4某些53. 异常(错误码)阐明54. 门票列表接口64.1. 接口地址64.2. 祈求类型64.3. 输入参数64.4. 返回成果64.5. 调用示例84.6. 返回json格式示例84.7. 返回xml格式示例95. 订单列表105.1. 接口地址105.2. 祈求类型105.3. 输入参数115.4. 返回成果115.5. 调用示例125.6. 返回json格式示例125.7. 返回xml格式示例136. 下单发票接口146.1. 接口地址146.2. 输入参数146.3. 返回成果156.4. 返回json格式示例166.5. 返回xml格式示例167. 退票接口177.1. 接口地址177.2. 输入参数177.3. 返回成果187.4. 返回json格式示例187.5. 返回xml格式示例198. 验证告知198.1. 告知参数198.2. 返回成果198.3. 返回json格式示例208.4. 返回xml格式示例20更新日记日期版本阐明作者-03-151.0创立文档莫灿宽-03-221.0添加退票接口莫灿宽-03-271.0下单接口添加开始游玩日期和价格类型参数莫灿宽-05-081.0下单接口返回信息中添加二维码参数qrcode莫灿宽1. 祈求参数阐明1.1. 接口域名阐明为了阐明以便我这里都假定接口域名是xxx.xxx.xxx。实际使用中如果是其她域名只需将相应域名代替xxx.xxx.xxx即可1.2. format 参数阐明 指定接口返回格式。重要包括三种格式：xml、json、php。如果未显式调用format参数，默认返回json格式。详细返回格式可查看详细接口返回示例获取xml格式获取json格式1.3. 接口访问权限合伙伙伴如果要访问接口至少要提供_pid和签名（签名是由授权码和参数生成）1.3.1. pid 参数阐明 每个接口都需要_pid参数，这是合伙伙伴编号，在此文档中有时叫合伙伙伴id. 1.3.2. 签名参数还需要签名来验证祈求合法性。签名生成规则：md5(md5(param1=value1¶m2=value2¶m3=value3).$authcode) md5：加密算法，32位md5算法$authcode：授权码param1=value1¶m2=value2¶m3=value3：传递给接口参数。各种参数用&连接注：1，所有参数(除_sig参数)需要按照键名英文排好顺序。2，参数规定：除_sig参数自身以外所有其她参加祈求接口参数。3，其中.号表达连接符号，即连接各种字符串。请勿理解成可见字符4，$authcode是授权码，即账号密码。5，什么参数被用来生产签名参数：如果使用GET方式祈求，则使用GET参数。如果使用POST方式祈求，则使用POST参数。两者只用其一php中生成签名示例：/ 祈求参数$params = array(cid = 1,_pid = 1,format = xml,);$authCode = 123456；/ 授权码/ 生成祈求参数 cid=1&format=xml&pid=10000ksort($params)；/ 参数排好序(多维数组时请自行递归)$query = http_build_query($params);/ 生成签名 7523690af2ccdf3f3ef595de68e86829/ $sig = md5( md5( “_pid=1&cid=1&format=xml” ) . “123456” )$sig = md5( md5( $query ) . $authCode )；/ 调用接口形式：祈求有4个参数，咱们排除_sig自身。使用cid,pid,format来生成签名。format不是必要。授权码（$authCode）是123456。如果不传递format,则签名是：md5( md5( “_pid=1&cid=1” ) . “123456” )。2. 返回数据阐明2.1. 返回数据分4某些1） success：表成功和失败状态。true表成功，false表失败。2） message：提示信息，当有错误发生时，此message包具有错误信息3） errorn：错误码，当有错误发生时，此errorn包具有错误码号4） 返回数据:如果是获取多条信息类接口则: list：多条信息列表 total：数据总数如果是获取单条信息类接口则: info：单条信息3. 异常(错误码)阐明1） 300500 = 没有数据2） 300501 = 参数错误3） 300502 = 顾客不存在4） 300503 = 顾客未开通接口授权5） 300504 = 授权码错误6） 300505 = 票不存在7） 300506 = 票已过期8） 300507 = 票数局限性9） 300508 = 获取分销商分组失败10） 300509 = 获取景区失败11） 300510 = 余额局限性12） 300511 = 短信发送失败13） 300512 = 余额更新失败14） 300513 = 票数修改失败15） 300514 = 订单添加失败16） 300515 = 出票失败17） 300516 = 顾客状态异常18） 300517 = 获取代理商信息失败19） 300518 = 订单不存在20） 300519 = 门票数局限性21） 300520 = 订单修改失败22） 300521 = 不容许退票23） 300522 = 退票类型无效24） 300523 = 退票审核中,不容许重复申请25） 300524 = 余额信息修改失败26） 300525 = 余额记录添加失败27） 300526 = 产品未定价，无法下单28） 300527 = 管理员审核发送产品必要发送短信29） 300528 = 导码产品不可以从淘宝下单30） 300529 = 获取码号与二维码失败31） 300530 = 导码状态更新失败32） 300531 = 购买数错误33） 300532 = 超过最晚下单时间34） 300533 = 没有跨站祈求权限35） 300534 = 补发次数超过限制次数4. 门票列表接口4.1. 接口地址4.2. 祈求类型POST 和 GET4.3. 输入参数名称类型与否必要描述methodstring必要固定值 item_listformatString可选返回文献格式，见format 参数阐明_pidNumber必要合伙伙伴id_sigString必要签名。见签名参数pageNumber可选列表页码，缺省获取第1页SizeNumber可选每页获取数量，缺省每页获取发15条信息cate_idNumber可选产品分类ID,缺省无，获取所有分类产品zoneNumber可选产品地区ID,缺省无，不作条件4.4. 返回成果名称类型描述successBoolean返回成果值，见返回数据阐明messageString提示信息描述errornNumber返回成果值，见异常阐明listList门票列表idNumber门票IDsupplier_idNumber景区IDtitleString门票标题typeNumber门票类型;1普通票，2套票，3线路send_typeNumber短信发送类型;1二维码，2文字码amountNumber门票数量original_priceNumber门票原价market_priceNumber市场价sort_orderNumber门票排序refund_typeNumber退票类型;1可退票，2审核退票，3不可退票validity_typeNumber有效期类型;1有效日期，2固定日期start_timeNumber开始时间，validity_type=2时为Unix 时间戳,validity_type=1时为下单后到有效期开始间隔时间,以秒计算expire_timeNumber结束时间，validity_type=2时为Unix 时间戳,validity_type=1时为下单后有效期开始时间,以天计算sms_contentString短信内容mms_contentString彩信内容print_contentString打印内容descriptionString描述信息is_importNumber与否是导入nett_priceNumber实际价格(成人价)nett_price2Number实际价格(小朋友价)4.5. 调用示例4.6. 返回json格式示例 success：true, message：成功, list： id：2, supplier_id：7, title：第二门票, status：1, type：1, send_type：1, quantity：91, original_price：200, market_price：123, sort_order：0, refund_type：1, validity_type：1, start_time：1800, expire_time：2, sms_content：尊敬姓名，凭此二维码电子票（门票码号码号）至景区扫描（或告知门票码号）验证成功即可进入，门票数票数张；有效期有效期, mms_content：null, print_content：打印内容, description：描述信息, is_import：0, nett_price：“200” , id：2, supplier_id：7, title：第二门票, status：1, type：1, send_type：1, quantity：91, original_price：200, market_price：123, sort_order：0, refund_type：1, validity_type：1, start_time：1800, expire_time：2, sms_content：尊敬姓名，凭此二维码电子票（门票码号码号）至景区扫描（或告知门票码号）验证成功即可进入，门票数票数张；有效期有效期, mms_content：null, print_content：打印内容, description：描述信息, is_import：0, nett_price：“200” . , total：15， /记录总数 errorn：0, runtime：0.3674.7. 返回xml格式示例 1 成功 2 7 第二门票 1 1 1 91 200 123 0 1 1 1800 2 尊敬姓名，凭此二维码电子票（门票码号码号）至景区扫描（或告知门票码号）验证成功即可进入，门票数票数张；有效期有效期 打印内容 描述信息 0 200 2 7 第二门票 1 1 1 91 200 123 0 1 1 1800 2 尊敬姓名，凭此二维码电子票（门票码号码号）至景区扫描（或告知门票码号）验证成功即可进入，门票数票数张；有效期有效期 打印内容 描述信息 0 200 . 15 0 0.06845. 订单列表5.1. 接口地址5.2. 祈求类型POST 和 GET5.3. 输入参数名称类型与否必要描述methodstring必要固定值 orders_listformatString可选返回文献格式，见format 参数阐明_pidNumber必要合伙伙伴id_sigString必要签名。见签名参数pageNumber可选列表页码，缺省获取第1页sizeNumber可选每页获取数量，缺省每页获取发15条信息item_id Number可选产品ID，缺省不做条件begin Number 可选开始时间戳，与end连用，缺省30天前时间戳endNumber 可选结束时间戳，与begin连用，缺省当前时间戳5.4. 返回成果名称类型描述successBoolean返回成果值，见返回数据阐明messageString提示信息描述errornNumber返回成果值，见异常阐明listList订单列表idNumber订单IDuser_idNumber顾客IDseller_idNumber分销商IDsupplier_idNumber景区IDtitleString订单标题nameString订单人名字mobileNumber订单人手机号payment_idNumber付款方式;1余额支付，2支付宝create_timeNumber下单时间is_sendNumber发送状态;1已发送，0未发送item_idNumber票IDsend_priceNumber票发送价total_priceNumber票总价priceNumber票单价amountNumber票总数valid_amountNumber可用数used_amountNumber使用数apply_amountNumber申请退票数cancel_amountNumber已退票数5.5. 调用示例5.6. 返回json格式示例 success：true, message：成功, list： id：15, code：00003, user_id：1, seller_id：1, supplier_id：7, title：北京故宫, name：阿宝, mobile：, payment_id：1, item_id：1, is_send：1, amount：3, valid_amount：0, used_amount：1, apply_amount：1, cancel_amount：1, price：0.00, send_price：1.00, total_price：277.00, create_time： , total：28, errorn：0, runtime：0.06845.7. 返回xml格式示例 1 成功 15 00003 1 1 7 北京故宫 阿宝 1 1 1 3 0 1 1 1 0.00 1.00 277.00 28 0 0.06846. 下单发票接口6.1. 接口地址6.2. 输入参数名称类型与否必要描述methodstring必要固定值 item_ordersformatString可选返回文献格式，见format 参数阐明_pidNumber必要合伙伙伴id_sigString必要签名。见签名参数orders_idstring可选第三方订单ID，可避免网络不好时重复下单item_idNumber必要要购买票IDsizeNumber可选购买票数,缺省1nameString必要购票人名称mobileNumber必要购票人手机号(成功后短信将发送门票码号到该手机号)start_dateDate可选开始游玩时间，缺省当前时间price_typeNumber可选价格类型；1成人，2小朋友，缺省1typeNumber可选类型,1本系统订单，2淘宝系统订单,缺省1sms_sendNumber可选与否发送告知短信，0不发送，1发送，缺省1(求账号要有发送短信权限)6.3. 返回成果名称类型描述successBoolean返回成果值，见返回数据阐明messageString提示信息描述errornNumber返回成果值，见异常阐明infoinfo订单信息 idNumber订单ID user_idNumber顾客ID seller_idNumber分销商ID supplier_idNumber景区ID titleString订单标题 nameString订单人名字 mobileNumber订单人手机号 payment_idNumber付款方式;1余额支付，2支付宝 create_timeNumber下单时间 is_sendNumber发送状态;1已发送，0未发送 item_idNumber票ID send_priceNumber票发送价 total_priceNumber票总价 priceNumber票单价 amountNumber票总数 valid_amountNumber可用数 used_amountNumber使用数 apply_amountNumber申请退票数 qrcodestring二维码数据 codestring文字码(码号)6.4. 返回json格式示例 success：true, message：成功, info： code：, user_id：3, seller_id：1, supplier_id：9, title：金钉子远古世界, name：akuan, mobile：, payment_id：1, create_time：, is_send：1, item_id：11, amount：3, price：116.00, total_price：348, send_price：1, start_time：, expire_time：, qrcode：“JBVYRctFfiZDMwOGRKRlZmRml0QnRSRkI=”, id：23 , errorn：0, runtime：0.336.5. 返回xml格式示例 1 成功 3 1 9 金钉子远古世界 akuan 1 1 11 20 116.00 2320 1 JBVYRctFfiZDMwOGRKRlZmRml0QnRSRkI= 25 0 0.957. 退票接口7.1. 接口地址7.2. 输入参数名称类型与否必要描述methodstring必要固定值 item_refundformatString可选返回文献格式，见format 参数阐明_pidNumber必要合伙伙伴id_sigString必要签名。见签名参数orders_idnumber必要要退票订单号sizeNumber可选退票数,缺省退票所有未使用票数7.3. 返回成果名称类型描述successBoolean返回成果值，见返回数据阐明messageString提示信息描述errornNumber返回成果值，见异常阐明infoinfo订单信息 idNumber退票记录ID user_idNumber顾客ID seller_idNumber分销商ID create_timeNumber记录时间 item_idNumber票ID priceNumber票总价 amountNumber票总数 feeNumber手续费 StatusNumber状态：1已使用，2申请退票，3退票成功，4退票不通过7.4. 返回json格式示例 success：true, message：成功, info： orders_id：22, status：3, amount：3, price：240, fee：0, create_time：, user_id：1, seller_id：1, item_id：11 , errorn：0, runtime：0.677.5. 返回xml格式示例 1 成功 22 3 2 160 0 1 1 11 0 0.2098. 验证推送告知(暂未使用)8.1. 告知参数名称类型与否必要描述methodstring必要固定值 validatesignstring必要签名codestring必要验证码号amo