商品導(dǎo)入接口規(guī)范

1、商品導(dǎo)入接口規(guī)范1. 調(diào)用入口不同的協(xié)議采用不同的調(diào)用入口，具體如下：協(xié)議調(diào)用入口SOAPHTTP如果需要創(chuàng)建SOAP客戶端，可以從以下地址獲取服務(wù)元數(shù)據(jù)（遵循WSDL標(biāo)準(zhǔn)）：2. 操作調(diào)用本接口包含身份驗(yàn)證（Authenticate）和導(dǎo)入商品（ImportGoods）兩個操作，每一個操作都有一個唯一的名稱，其調(diào)用地址為：調(diào)用入口 + 路徑分隔符 + 操作名，例如身份認(rèn)證操作的調(diào)用入口為：http:/ http:/ 3. 操作參數(shù)（1） 不同的操作有不同的參數(shù)，詳見商品導(dǎo)入接口操作說明。（2） 所有參數(shù)都需要序列化，序列化規(guī)則參見本文檔中的“序列化規(guī)則”一節(jié)。（3） 參數(shù)中包含中文字符時需要

2、編碼，編碼標(biāo)準(zhǔn)采用utf-8。（4） 采用HTTP協(xié)議時，所有參數(shù)均以POST方法提交，并封裝于請求正文。（5） 調(diào)用導(dǎo)入商品操作時需要攜帶Cookie身份憑證，此身份憑證由身份驗(yàn)證操作頒發(fā)，由調(diào)用方負(fù)責(zé)保存。4. 操作返回值（1） 各操作的返回值參見商品導(dǎo)入接口操作說明。（2） 返回值已序列化，序列化規(guī)則見本文檔中的“序列化規(guī)則”一節(jié)。（3） 返回值中如果包含中文字符，采用utf-8標(biāo)準(zhǔn)進(jìn)行編碼。（4） 服務(wù)端執(zhí)行操作失敗將向調(diào)用方發(fā)送錯誤信息，錯誤信息數(shù)據(jù)結(jié)構(gòu)的名稱為BusinessFault，其序列化規(guī)則請參見本文檔中的“序列化規(guī)則”一節(jié)。（5） 采用HTTP協(xié)議時，不論服務(wù)端執(zhí)行成功還

3、是失敗返回的Http狀態(tài)碼均為200，如果執(zhí)行成功則在響應(yīng)消息正文中包含返回值（已序列化），如果執(zhí)行失敗則在響應(yīng)消息正文中包含錯誤信息（已序列化）。5. 序列化規(guī)則使用SOAP協(xié)議調(diào)用接口時，僅支持XML序列化方案。如果使用HTTP REST協(xié)議調(diào)用接口，則可以自主指定XML或JSON序列化方案，指定方式為在HTTP請求頭中設(shè)置“Content-Type: application/xml”或“Content-Type: application/json”。（1） 請求數(shù)據(jù)的序列化XML序列化：<操作名 xmlns=""> <簡單參數(shù)名>參數(shù)值<

4、/簡單參數(shù)名> <!-對于枚舉類型，用枚舉項(xiàng)名稱-> <復(fù)雜參數(shù)名 xmlns:i="/2001/XMLSchema-instance"> <屬性名>屬性值</屬性名> <!-對于枚舉類型，用枚舉項(xiàng)名稱-> <屬性名>屬性值</屬性名> <!-更多屬性-> </復(fù)雜參數(shù)名> <集合參數(shù)名 xmlns:i="/2001/XMLSchema-instance"> <

5、元素類型名></元素類型名> <元素類型名></元素類型名> <!-更多元素-> </集合參數(shù)名> </操作名>請求數(shù)據(jù)XML序列化示例：<JoinSchool xmlns=""> <!-操作名：JoinSchool-> <persons xmlns:i="/2001/XMLSchema-instance"> <!-集合參數(shù)：persons-> <Person> <!-集合中的第一

6、個元素-> <Age>22</Age> <Province>湖北省</Province> <Schools><!Person類的Schools屬性，為集合類型-> <School> <Age>80</Age> <IsGood>false</IsGood> <!-bool類型-> <Name>沙洋中學(xué)</Name> <Type>GaoZhong</Type> <!-枚舉類型，使用枚舉項(xiàng)值->

7、; </School> </Schools> <Sex>男</Sex> </Person> <Person> <!-集合中的第二個元素-> <Age>23</Age> <Province>湖北省</Province> <Schools> <School> <Age>60</Age> <IsGood>false</IsGood> <Name>襄樊一中</Name> <

8、;Type>GaoZhong</Type> </School> </Schools> <Sex>男</Sex> </Person> </persons> <school xmlns:i="/2001/XMLSchema-instance"> <!-復(fù)雜參數(shù)：school-> <Age>90</Age> <IsGood>true</IsGood> <Name>湖北大學(xué)<

9、;/Name> <Type>DaXue</Type> </school> <joinTime>2014-09-03</joinTime> <!-簡單參數(shù)：joinTime-></JoinSchool>JSON序列化：“簡單參數(shù)名”：”簡單參數(shù)值”，<!-對于枚舉類型，用枚舉值->“復(fù)雜參數(shù)名”：“屬性名1”:”屬性值1”,<!-對于枚舉類型，用枚舉值->“屬性名2”:”屬性值2”<!-更多屬性-> ,“集合參數(shù)名”：<!集合中的第一個對象->“屬性名1”:”

10、屬性值1”,“屬性名2”:”屬性值2”<!-更多屬性-> ,<!集合中的第二個對象->“屬性名1”:”屬性值1”,“屬性名1”:”屬性值2”<!-更多屬性-> <!-更多對象->請求數(shù)據(jù)JSON序列化示例："persons":<!集合參數(shù)：persons-><!集合中的第一個對象->"Age":10,"Province":"湖北省","Schools":<!Person類的Schools屬性，為集合類型->&qu

11、ot;Age":"70","IsGood":false,<!bool類型->"Name":"沙洋中學(xué)","Type":0<!枚舉類型，使用枚舉值->,"Sex":"男",<!集合中的第二個對象->"Age":23,"Province":"湖北省","Schools":"Age":70,"IsGood&q

12、uot;:false,"Name":"襄樊一中","Type":0,"Sex":"男”,"school":<!復(fù)雜參數(shù)：school->"Age":90,"IsGood":true,"Name":"湖北大學(xué)","Type":2,"joinTime":"2014-09-03"<!簡單參數(shù)：joinTime->（2） 返回值的序

13、列化XML序列化：<!-基元類型返回值-><操作名Response xmlns=""> <操作名Result>返回值</操作名Result> <!-對于枚舉類型，使用枚舉項(xiàng)名稱-></操作名Response><!-復(fù)雜類型返回值-><操作名Response xmlns=""> <操作名Result xmlns:i="/2001/XMLSchema-instance"> <屬性名>屬性值

14、</屬性名> <!-對于枚舉類型，使用枚舉項(xiàng)名稱-> <屬性名>屬性值</屬性名> <屬性名>屬性值</屬性名> <!-更多屬性-> </操作名Result></操作名Response><!-集合類型返回值-><操作名Response xmlns=""> <操作名Result xmlns:i="/2001/XMLSchema-instance"> <元素類型名><

15、/元素類型名><元素類型名></元素類型名><!-更多元素-> </操作名Result> </操作名Response>返回值XML序列化示例：<!-基元類型返回值示例-><GetSchoolTypeResponse xmlns=""> <GetSchoolTypeResult>DaXue</GetSchoolTypeResult></GetSchoolTypeResponse><!-復(fù)雜類型返回值示例-><GetPersonResp

16、onse xmlns=""> <GetPersonResult xmlns:i="/2001/XMLSchema-instance"> <Age>22</Age> <Province>北京</Province> <Schools><!-一個集合類型的屬性：Schools-> <School><!-Schools集合第一個對象-> <Age>80</Age> <IsGood>f

17、alse</IsGood><!-bool類型-> <Name>沙洋中學(xué)</Name> <Type>GaoZhong</Type><!枚舉類型-> </School> <School><!-Schools集合第二個對象-> <Age>90</Age> <IsGood>true</IsGood> <Name>湖北大學(xué)</Name> <Type>DaXue</Type> </Sch

18、ool> </Schools> <Sex>女</Sex> </GetPersonResult></GetPersonResponse><!-集合類型返回值示例-><GetSchoolsResponse xmlns=""> <GetSchoolsResult xmlns:i="/2001/XMLSchema-instance"> <School> <!-集合中的第一個元素-> <Age>8

19、0</Age> <IsGood>false</IsGood><!-bool類型-> <Name>沙洋中學(xué)</Name> <Type>GaoZhong</Type><!枚舉類型-> </School> <School> <!-集合中的第二個元素-> <Age>90</Age> <IsGood>true</IsGood> <Name>湖北大學(xué)</Name> <Type>Da

20、Xue</Type> </School> </GetSchoolsResult></GetSchoolsResponse>JSON序列化：<!-基元類型返回值->“操作名Result”：返回數(shù)據(jù)<!對于枚舉類型，使用枚舉值-><!-復(fù)雜類型返回值, 返回類型為類，結(jié)構(gòu)等類型時適用->“操作名Result”：“屬性名1”：”屬性值1”,<!對于枚舉類型，使用枚舉值->“屬性名2”：”屬性值2”<!更多屬性-><!-集合類型返回值->“操作名Result”:<!集合對象1-

21、>“屬性名1”:”屬性值1”,<!對于枚舉類型，使用枚舉值->“屬性名2”:”屬性值2”,<!-更多屬性->,<!集合對象1->“屬性名1”:”屬性值1”,“屬性名2”:”屬性值2”,<!-更多屬性-><!-更多對象->返回值JSON序列化示例：<!-基元類型返回值->“GetSchoolTypeResult”：3<!-枚舉類型使用枚舉值，而不是枚舉項(xiàng)名稱-><!-復(fù)雜類型返回值->“GetPersonResult”：“Age”:22,“Province”:”湖北省”,“Schools”：<!-一個集合類型的屬性：Schools-><!-Schools集合第一個對象->“Age”：90,“IsGood”：false,<!-bool類型->“Name”：”湖北大學(xué)”,“Type”：3<!-枚舉類型->,<!- Schools