ecstore接口文檔規(guī)則

1、數(shù)據(jù)中心接口說明目錄數(shù)據(jù)中心接口說明1目錄1更新日志31. 請(qǐng)求參數(shù)說明31.1. 接口域名說明31.2. format 參數(shù)說明31.3. 接口訪問權(quán)限31.3.1. pid 參數(shù)說明31.3.2. 簽名參數(shù)32. 返回?cái)?shù)據(jù)說明52.1. 返回?cái)?shù)據(jù)分4部分53. 異常(錯(cuò)誤碼)說明54. 門票列表接口64.1. 接口地址64.2. 請(qǐng)求類型64.3. 輸入?yún)?shù)64.4. 返回結(jié)果64.5. 調(diào)用示例84.6. 返回json格式示例84.7. 返回xml格式示例95. 訂單列表105.1. 接口地址105.2. 請(qǐng)求類型105.3. 輸入?yún)?shù)115.4. 返回結(jié)果115.5. 調(diào)用示例125.

2、6. 返回json格式示例125.7. 返回xml格式示例136. 下單發(fā)票接口146.1. 接口地址146.2. 輸入?yún)?shù)146.3. 返回結(jié)果156.4. 返回json格式示例166.5. 返回xml格式示例167. 退票接口177.1. 接口地址177.2. 輸入?yún)?shù)177.3. 返回結(jié)果187.4. 返回json格式示例187.5. 返回xml格式示例198. 驗(yàn)證通知198.1. 通知參數(shù)198.2. 返回結(jié)果198.3. 返回json格式示例208.4. 返回xml格式示例20更新日志日期版本說明作者2013-03-151.0創(chuàng)建文檔莫燦寬2013-03-221.0添加退票接口莫燦

3、寬2013-03-271.0下單接口添加開始游玩日期和價(jià)格類型參數(shù)莫燦寬2013-05-081.0下單接口返回信息中添加二維碼參數(shù)qrcode莫燦寬1. 請(qǐng)求參數(shù)說明1.1. 接口域名說明為了說明的方便我這里都假定接口域名是xxx.xxx.xxx。實(shí)際使用中如果是其他域名只需將相應(yīng)域名替代xxx.xxx.xxx即可1.2. format 參數(shù)說明 指定接口返回格式。主要包含三種格式：xml、json、php。如果未顯式調(diào)用format參數(shù)，默認(rèn)返回json格式。具體返回格式可查看具體接口的返回示例獲取xml格式http:/xxx.xxx.xxx/Api/seller/api.php?forma

4、t=xml&cid=1&pid=10000獲取json格式http:/xxx.xxx.xxx/Api/seller/api.php?format=json&cid=1&pid=100001.3. 接口訪問權(quán)限合作伙伴如果要訪問接口至少要提供_pid和簽名（簽名是由授權(quán)碼和參數(shù)生成）1.3.1. pid 參數(shù)說明 每個(gè)接口都需要_pid參數(shù)，這是合作伙伴的編號(hào)，在此文檔中有時(shí)叫合作伙伴id. 1.3.2. 簽名參數(shù)還需要簽名來驗(yàn)證請(qǐng)求的合法性。簽名生成規(guī)則：md5(md5('param1=value1&param2=value2&param

5、3=value3').$authcode) md5: 加密算法，32位md5算法$authcode: 授權(quán)碼param1=value1&param2=value2&param3=value3：傳遞給接口的參數(shù)。多個(gè)參數(shù)用&連接注：1，所有參數(shù)(除_sig參數(shù))需要按照鍵名英文排好次序。2，參數(shù)要求：除_sig參數(shù)本身以外的所有其他參與請(qǐng)求接口的參數(shù)。3，其中的.號(hào)表示連接符號(hào)，即連接多個(gè)字符串。請(qǐng)勿理解成可見的字符4，$authcode是授權(quán)碼，即賬號(hào)密碼。5，什么參數(shù)被用來生產(chǎn)簽名參數(shù)：如果使用GET方式請(qǐng)求，則使用GET參數(shù)。如果使用POST方式請(qǐng)求，則使用

6、POST參數(shù)。二者只用其一php中生成簽名示例：/ 請(qǐng)求參數(shù)$params = array('cid' => 1,'_pid' => 1,'format' => 'xml',);$authCode = 123456; / 授權(quán)碼/ 生成請(qǐng)求參數(shù) cid=1&format=xml&pid=10000ksort($params); / 參數(shù)排好序(多維數(shù)組時(shí)請(qǐng)自行遞歸)$query = http_build_query($params);/ 生成簽名 7523690af2ccdf3f3ef595de6

7、8e86829/ $sig = md5( md5( “_pid=1&cid=1&format=xml” ) . “123456” )$sig = md5( md5( $query ) . $authCode ); / 調(diào)用接口形式：http:/xxx.xxx.xxx/Api/seller/api.php?format=json&cid=1&pid=10000&_sig=0100194fd8a8999d0de8d0318b0fe8d6請(qǐng)求有4個(gè)參數(shù)，我們排除_sig本身。使用cid,pid,format來生成簽名。format不是必須的。授權(quán)碼（$auth

8、Code）是123456。如果不傳遞format,則簽名是：md5( md5( “_pid=1&cid=1” ) . “123456” )。2. 返回?cái)?shù)據(jù)說明2.1. 返回?cái)?shù)據(jù)分4部分1） success: 表成功和失敗狀態(tài)。true表成功，false表失敗。2） message: 提示信息，當(dāng)有錯(cuò)誤發(fā)生時(shí)，此message包含有錯(cuò)誤信息3） errorn: 錯(cuò)誤碼，當(dāng)有錯(cuò)誤發(fā)生時(shí)，此errorn包含有錯(cuò)誤碼號(hào)4） 返回?cái)?shù)據(jù):如果是獲取多條信息類接口則: list: 多條信息列表 total: 數(shù)據(jù)總數(shù)如果是獲取單條信息類接口則: info: 單條信息3. 異常(錯(cuò)誤碼)說明1） 30

9、0500 => 沒有數(shù)據(jù)2） 300501 => 參數(shù)錯(cuò)誤3） 300502 => 用戶不存在4） 300503 => 用戶未開通接口授權(quán)5） 300504 => 授權(quán)碼錯(cuò)誤6） 300505 => 票不存在7） 300506 => 票已過期8） 300507 => 票數(shù)不足9） 300508 => 獲取分銷商分組失敗10） 300509 => 獲取景區(qū)失敗11） 300510 => 余額不足12） 300511 => 短信發(fā)送失敗13） 300512 => 余額更新失敗14） 300513 => 票數(shù)修改失敗

10、15） 300514 => 訂單添加失敗16） 300515 => 出票失敗17） 300516 => 用戶狀態(tài)異常18） 300517 => 獲取代理商信息失敗19） 300518 => 訂單不存在20） 300519 => 門票數(shù)不足21） 300520 => 訂單修改失敗22） 300521 => 不允許退票23） 300522 => 退票類型無效24） 300523 => 退票審核中,不允許重復(fù)申請(qǐng)25） 300524 => 余額信息修改失敗26） 300525 => 余額記錄添加失敗27） 300526 =>

11、; 產(chǎn)品未定價(jià)，無法下單28） 300527 => 管理員審核發(fā)送的產(chǎn)品必須發(fā)送短信29） 300528 => 導(dǎo)碼產(chǎn)品不可以從淘寶下單30） 300529 => 獲取碼號(hào)與二維碼失敗31） 300530 => 導(dǎo)碼狀態(tài)更新失敗32） 300531 => 購買數(shù)錯(cuò)誤33） 300532 => 超過最晚下單時(shí)間34） 300533 => 沒有跨站請(qǐng)求權(quán)限35） 300534 => 補(bǔ)發(fā)次數(shù)超出限制次數(shù)4. 門票列表接口4.1. 接口地址http:/xxx.xxx.xxx/Api/seller/api.php4.2. 請(qǐng)求類型POST 和 GET4.

12、3. 輸入?yún)?shù)名稱類型是否必須描述methodstring必須固定值 item_listformatString可選返回文件格式，見format 參數(shù)說明_pidNumber必須合作伙伴id_sigString必須簽名。見簽名參數(shù)pageNumber可選列表頁碼，缺省獲取第1頁SizeNumber可選每頁獲取數(shù)量，缺省每頁獲取發(fā)15條信息cate_idNumber可選產(chǎn)品分類ID,缺省無，獲取所有分類產(chǎn)品zoneNumber可選產(chǎn)品地區(qū)ID,缺省無，不作條件4.4. 返回結(jié)果名稱類型描述successBoolean返回結(jié)果值，見返回?cái)?shù)據(jù)說明messageString提示信息描述errornNu

13、mber返回結(jié)果值，見異常說明listList門票列表idNumber門票IDsupplier_idNumber景區(qū)IDtitleString門票標(biāo)題typeNumber門票類型;1普通票，2套票，3線路send_typeNumber短信發(fā)送類型;1二維碼，2文字碼amountNumber門票數(shù)量original_priceNumber門票原價(jià)market_priceNumber市場(chǎng)價(jià)sort_orderNumber門票排序refund_typeNumber退票類型;1可退票，2審核退票，3不可退票validity_typeNumber有效期類型;1有效日期，2固定日期start_timeNu

14、mber開始時(shí)間，validity_type=2時(shí)為Unix 時(shí)間戳,validity_type=1時(shí)為下單后到有效期開始的間隔時(shí)間,以秒計(jì)算expire_timeNumber結(jié)束時(shí)間，validity_type=2時(shí)為Unix 時(shí)間戳,validity_type=1時(shí)為下單后有效期開始時(shí)間,以天計(jì)算sms_contentString短信內(nèi)容mms_contentString彩信內(nèi)容print_contentString打印內(nèi)容descriptionString描述信息is_importNumber是否是導(dǎo)入nett_priceNumber實(shí)際價(jià)格(成人價(jià))nett_price2Number實(shí)

15、際價(jià)格(兒童價(jià))4.5. 調(diào)用示例http:/xxx.xxx.xxx/Api/seller/api.php?method=item_list&format=json&page=1&size=5&_pid=2&_sig=xxx4.6. 返回json格式示例 "success": true, "message": "成功", "list": "id": "2", "supplier_id": "7",

16、 "title": "第二門票", "status": "1", "type": "1", "send_type": "1", "quantity": "91", "original_price": "200", "market_price": "123", "sort_order": "

17、0", "refund_type": "1", "validity_type": "1", "start_time": "1800", "expire_time": "2", "sms_content": "尊敬的姓名，憑此二維碼電子票（門票碼號(hào)碼號(hào)）至景區(qū)掃描（或告知門票碼號(hào)）驗(yàn)證成功即可進(jìn)入，門票數(shù)票數(shù)張；有效期有效期", "mms_content": null,

18、 "print_content": "打印內(nèi)容", "description": "描述信息", "is_import": "0", "nett_price": “200” , "id": "2", "supplier_id": "7", "title": "第二門票", "status": "1"

19、, "type": "1", "send_type": "1", "quantity": "91", "original_price": "200", "market_price": "123", "sort_order": "0", "refund_type": "1", "validity_type&qu

20、ot;: "1", "start_time": "1800", "expire_time": "2", "sms_content": "尊敬的姓名，憑此二維碼電子票（門票碼號(hào)碼號(hào)）至景區(qū)掃描（或告知門票碼號(hào)）驗(yàn)證成功即可進(jìn)入，門票數(shù)票數(shù)張；有效期有效期", "mms_content": null, "print_content": "打印內(nèi)容", "description":

21、"描述信息", "is_import": "0", "nett_price": “200” . , "total": 15, /記錄總數(shù) "errorn": 0, "runtime": 0.0312480926513674.7. 返回xml格式示例 <root> <success>1</success> <message>成功</message> <list> <item id=

22、"0"> <d>2</id> <supplier_id>7</supplier_id> <title>第二門票</title> <status>1</status> <type>1</type> <send_type>1</send_type> <quantity>91</quantity> <original_price>200</original_price> <mar

23、ket_price>123</market_price> <sort_order>0</sort_order> <refund_type>1</refund_type> <validity_type>1</validity_type> <start_time>1800</start_time> <expire_time>2</expire_time> <sms_content> 尊敬的姓名，憑此二維碼電子票（門票碼號(hào)碼號(hào)）至景區(qū)掃描（或告知門票碼

24、號(hào)）驗(yàn)證成功即可進(jìn)入，門票數(shù)票數(shù)張；有效期有效期 </sms_content> <mms_content/> <print_content>打印內(nèi)容</print_content> <description>描述信息</description> <is_import>0</is_import> <nett_price>200</nett_price> </item> <item id="1"> <d>2</id&g

25、t; <supplier_id>7</supplier_id> <title>第二門票</title> <status>1</status> <type>1</type> <send_type>1</send_type> <quantity>91</quantity> <original_price>200</original_price> <market_price>123</market_price>

26、 <sort_order>0</sort_order> <refund_type>1</refund_type> <validity_type>1</validity_type> <start_time>1800</start_time> <expire_time>2</expire_time> <sms_content> 尊敬的姓名，憑此二維碼電子票（門票碼號(hào)碼號(hào)）至景區(qū)掃描（或告知門票碼號(hào)）驗(yàn)證成功即可進(jìn)入，門票數(shù)票數(shù)張；有效期有效期 </sms_con

27、tent> <mms_content/> <print_content>打印內(nèi)容</print_content> <description>描述信息</description> <is_import>0</is_import> <nett_price>200</nett_price> </item> . </list> <total>15</total> <errorn>0</errorn> <runti

28、me>0.015624046325684</runtime></root>5. 訂單列表5.1. 接口地址http:/xxx.xxx.xxx/Api/seller/api.php5.2. 請(qǐng)求類型POST 和 GET5.3. 輸入?yún)?shù)名稱類型是否必須描述methodstring必須固定值 orders_listformatString可選返回文件格式，見format 參數(shù)說明_pidNumber必須合作伙伴id_sigString必須簽名。見簽名參數(shù)pageNumber可選列表頁碼，缺省獲取第1頁sizeNumber可選每頁獲取數(shù)量，缺省每頁獲取發(fā)15條信息ite

29、m_id Number可選產(chǎn)品ID，缺省不做條件begin Number 可選開始時(shí)間戳，與end連用，缺省30天前時(shí)間戳endNumber 可選結(jié)束時(shí)間戳，與begin連用，缺省當(dāng)前時(shí)間戳5.4. 返回結(jié)果名稱類型描述successBoolean返回結(jié)果值，見返回?cái)?shù)據(jù)說明messageString提示信息描述errornNumber返回結(jié)果值，見異常說明listList訂單列表idNumber訂單IDuser_idNumber用戶IDseller_idNumber分銷商IDsupplier_idNumber景區(qū)IDtitleString訂單標(biāo)題nameString訂單人名字mobileNum

30、ber訂單人手機(jī)號(hào)payment_idNumber付款方式;1余額支付, 2支付寶create_timeNumber下單時(shí)間is_sendNumber發(fā)送狀態(tài);1已發(fā)送，0未發(fā)送item_idNumber票IDsend_priceNumber票發(fā)送價(jià)total_priceNumber票總價(jià)priceNumber票單價(jià)amountNumber票總數(shù)valid_amountNumber可用數(shù)used_amountNumber使用數(shù)apply_amountNumber申請(qǐng)退票數(shù)cancel_amountNumber已退票數(shù)5.5. 調(diào)用示例http:/xxx.xxx.xxx/Api/seller/a

31、pi.php?method=orders_list&format=json&page=1&size=5&_pid=10000&_sig=xxx5.6. 返回json格式示例 "success": true, "message": "成功", "list": "id": "15", "code": "00003", "user_id": "1", "

32、seller_id": "1", "supplier_id": "7", "title": "北京故宮", "name": "阿寶", "mobile": "quot;, "payment_id": "1", "item_id": "1", "is_send": "1", &

33、quot;amount": "3", "valid_amount": "0", "used_amount": "1", "apply_amount": "1", "cancel_amount": "1", "price": "0.00", "send_price": "1.00", "total_price"

34、: "277.00", "create_time": "1363676652" , "total": 28, "errorn": 0, "runtime": 0.0156240463256845.7. 返回xml格式示例<root> <success>1</success> <message>成功</message> <list> <item id="0"> <id&

35、gt;15</id> <code>00003</code> <user_id>1</user_id> <seller_id>1</seller_id> <supplier_id>7</supplier_id> <title>北京故宮</title> <name>阿寶</name> <mobile>lt;/mobile> <payment_id>1</payment_id> &

36、lt;item_id>1</item_id> <is_send>1</is_send> <amount>3</amount> <valid_amount>0</valid_amount> <used_amount>1</used_amount> <apply_amount>1</apply_amount> <cancel_amount>1</cancel_amount> <price>0.00</price>

37、<send_price>1.00</send_price> <total_price>277.00</total_price> <create_time>1363676652</create_time> </item> </list> <total>28</total> <errorn>0</errorn> <runtime>0.015624046325684</runtime></root>6. 下單發(fā)票接口6.1

38、. 接口地址http:/xxx.xxx.xxx/Api/seller/api.php6.2. 輸入?yún)?shù)名稱類型是否必須描述methodstring必須固定值 item_ordersformatString可選返回文件格式，見format 參數(shù)說明_pidNumber必須合作伙伴id_sigString必須簽名。見簽名參數(shù)orders_idstring可選第三方訂單ID，可避免網(wǎng)絡(luò)不好時(shí)重復(fù)下單item_idNumber必須要購買的票IDsizeNumber可選購買票數(shù),缺省1nameString必須購票人名稱mobileNumber必須購票人手機(jī)號(hào)(成功后短信將發(fā)送門票碼號(hào)到該手機(jī)號(hào))star

39、t_dateDate可選開始游玩時(shí)間，缺省當(dāng)前時(shí)間price_typeNumber可選價(jià)格類型；1成人，2兒童，缺省1typeNumber可選類型,1本系統(tǒng)訂單，2淘寶系統(tǒng)訂單,缺省1sms_sendNumber可選是否發(fā)送通知短信，0不發(fā)送，1發(fā)送，缺省1(求賬號(hào)要有發(fā)送短信權(quán)限)6.3. 返回結(jié)果名稱類型描述successBoolean返回結(jié)果值，見返回?cái)?shù)據(jù)說明messageString提示信息描述errornNumber返回結(jié)果值，見異常說明infoinfo訂單信息 idNumber訂單ID user_idNumber用戶ID seller_idNumber分銷商ID supplier_

40、idNumber景區(qū)ID titleString訂單標(biāo)題 nameString訂單人名字 mobileNumber訂單人手機(jī)號(hào) payment_idNumber付款方式;1余額支付, 2支付寶 create_timeNumber下單時(shí)間 is_sendNumber發(fā)送狀態(tài);1已發(fā)送，0未發(fā)送 item_idNumber票ID send_priceNumber票發(fā)送價(jià) total_priceNumber票總價(jià) priceNumber票單價(jià) amountNumber票總數(shù) valid_amountNumber可用數(shù) used_amountNumber使用數(shù) apply_amountNumber申請(qǐng)

41、退票數(shù) qrcodestring二維碼數(shù)據(jù) codestring文字碼(碼號(hào))6.4. 返回json格式示例 "success": true, "message": "成功", "info": "code": "912856115772", "user_id": "3", "seller_id": "1", "supplier_id": "9", "

42、;title": "金釘子遠(yuǎn)古世界", "name": "akuan", "mobile": "quot;, "payment_id": 1, "create_time": 1363937085, "is_send": 1, "item_id": "11", "amount": "3", "price": &quo

43、t;116.00", "total_price": 348, "send_price": 1, "start_time": 1363937085, "expire_time": 1364023485, "qrcode": “JBVYRctFfiZDMwOGRKRlZmRml0QnRSRkI=”, "id": "23" , "errorn": 0, "runtime": 0.200698137283336.5

44、. 返回xml格式示例<root> <success>1</success> <message>成功</message> <info> <code>226024261199</code> <user_id>3</user_id> <seller_id>1</seller_id> <supplier_id>9</supplier_id> <title>金釘子遠(yuǎn)古世界</title> <name>

45、akuan</name> <mobile>lt;/mobile> <payment_id>1</payment_id> <create_time>1363937238</create_time> <is_send>1</is_send> <item_id>11</item_id> <amount>20</amount> <price>116.00</price> <total_price>

46、;2320</total_price> <send_price>1</send_price> <start_time>1363937238</start_time> <expire_time>1364023638</expire_time> <qrcode>JBVYRctFfiZDMwOGRKRlZmRml0QnRSRkI=</qrcode> <id>25</id> </info> <errorn>0</errorn> <runtime>0.33985114097595</runtime></root>7. 退票接口7.1. 接口地址http:/xxx.xxx.xxx/Api/seller/api.php7.2. 輸入?yún)?shù)名稱類型是否必須描述methodstring必須固定值 item_refundformatString可選返回文件格式，見format 參數(shù)說明_pidNumber必須合作伙伴id_sigString必須簽名。見簽名參數(shù)