世聯翻譯公司完成公司系統規范中文翻譯
時間:2018-09-11 14:13 來源:未知 作者:dongli 點擊:次
世聯翻譯公司完成公司系統規范中文翻譯
 2 接口規范說明 通用對外服務接口統一使用UTF-8編碼的XML報文，接口通信協議支持 WEBSERVICE、HTTP/POST、FTP三種協議，當前主要使用WEBSERVICE協議方式。 通用對外服務接口分為主動接入與對外推送兩類接口，基于 FTP 協議的對外推送類接口無需對應的響應報文，其他均存在對應的請求與響應報文；以下定義了通用對外服務接口報文需要遵循的格式與規則： ² 請求報文： <Request service="服務名"lang="zh-CN"> <Head>客戶卡號,校驗碼</Head> <Body>請求數據 XML</Body> </Request> 關鍵規則： a) service屬性與HEAD元素預先定義了服務名，客戶卡號及檢驗碼，結合請求的客戶IP地址可以滿足只要通過預解析HEAD元素就能夠進行系統功能權限的驗證，無功能權限情況下無需進一步解析Body內部數據，大大提高了攔截非法訪問的性能； b) 客戶卡號與校驗碼統一使用順豐分配的客戶卡號與校驗碼； c) lang屬性用于支持國際化請求，缺省值為 zh-CN。 ² 響應報文： <Response service="服務名"> <Head>OK|ERR</HEAD> <BODY>正常響應數據 XML</BODY> <ERROR code="NNNN">錯誤詳細信息</ERROR> </Response> 關鍵規則： a) Head元素值為OK或ERR；OK代表交易正常，ERR代表發生系統或業務異常；對于批量交易場景，部分交易異常必須返回OK值，且必須在返回BODY中標識出發生異常的交易記錄，避免下次全部重發； b) Head元素值為OK時返回BODY元素，為ERR時返回ERROR元素；BODY與ERROR元素不能同時存在； c) ERROR元素中的code屬性值為四位數字，錯誤編碼的描述請參考文檔的最后一個部分。 ² 批量交易記錄數限制為20條以下（參考順豐網站），特定業務可以自定義不支持批量交易或小于20的批量記錄數限制。 ² 請求或正常響應數據XML中數據元素的定義需遵循將必要字段（包含有默認值的字段），可選字段及擴展字段進行分開定義的原則，同時字段盡量通過元素的屬性進行定義，字段值限制在200字符以下（50個漢字以下）；必要字段使用數據元素本身的屬性進行定義，可選項字段在數據元素下定義“數據元素名+Option”元素并通過其屬性進行定義，擴展字段使用數據元素下保留元素<Extra>的屬性進行定義；必要字段的數目盡量控制在10個以下；如： <Order id="XXXX" …> <OrderOption payment="XXXX" …/> <Extra e1="XXXX" …/> </Order> OrderOption元素的屬性及值由具體的業務數據定義；Extra元素最大支持20個屬性，屬性名為e1,…,e20,只支持字符串值。 ² 盡量通過客戶個性化服務配置的方式減少接口報文需要傳遞的字段量，如在訂單報文中加 入發貨點代碼的方式，可以在后臺基于客戶+發貨點代碼的方式配置月結賬號等等數據，避免在接口報文中傳遞附加的月結賬號。 ² 請求與響應報文元素命名采用大寫字母開頭的單詞序列，如“OrderResponse”；屬性名統一使用小寫，如“orderid”；子元素在定義表格中一律使用“/”徑表示，如“outeTrackingResponse/Route”； 通用對外服務接口當前已經定義了快遞類服務接口，其參考地址參見： Http://bsp-oip/sf-express.com/bsp-ois/ws/expressService 3 快遞類服務接口 3.1 下訂單（含篩選） 3.1.1 功能描述 下單接口根據客戶需要，可提供以下三個功能： 1） 客戶系統向順豐下發訂單。 2） 為訂單分配運單號。 3） 篩單。 3.1.2 接口主信息定義
3.1.3 可選字段信息
增值服務傳值說明:
3.1.4 擴展字段信息 遵循擴展字段規范 3.1.5 應用場景XML實例 ² 場景1 場景描述：客戶下單 請求XML： <Request service=”OrderService” lang="zh-CN"> <Head>j_custid（客戶卡號）,checkwork（校驗碼）</Head> <Body> <Order orderid=”訂單號” express_type=”快件類型”j_company=”寄件方公司名稱” j_contact=”寄件方聯系人”j_tel=”聯系電話”j_address=”寄件地址”d_company=”到件方公司名稱”d_contact=”到件方聯系人”d_tel=”聯系電話”d_address=”到件方地址” parcel_quantity=”包裹數”pay_method=”付款方式”> <OrderOption custid=”月結卡號”j_shippercode=”寄件方代碼”d_deliverycode=”到 件方代碼”cargo=”貨物名稱”cargo_total_weight=”總重量”insurance_amount=”申明價值”sendstarttime=”要求上門收件時間” mailno=”運單號” remark=”備注”> <AddedService name=”增值服務 1” value=”值 1” value1=”值 2” value2=”值 3” value3=”值 4” value4=”值 5”/> <!-- ...// <AddedService>可有多個--> </OrderOption> <Extra e1=”擴展字段” e2=”擴展字段” e3=”擴展字段” e4=”擴展字段” e5=”擴展字段” e6=”擴展字 段” e7=”擴展字段” e8=”擴展字段” e9=”擴展字段” e10=”擴展字段” e11=”擴展字段” e12=”擴展字 段” e13=”擴展字段” e14=”擴展字段” e15=”擴展字段” e16=”擴展字段” e17=”擴展字段” e18=”擴展 字段” e19=”擴展字段” e20=”擴展字段”/> </Order> </Body> </Request> 響應XML： 訂單處理成功： <Response service=”OrderService”> <Head>OK</Head> <Body> <OrderResponse orderid=”訂單號” mailno=”主單,子單 1,子單 2,…,子單 n” originCode=”原寄地代碼” destCode=”目的地代碼” filter_result=”篩單結果” remark=”備注”/> </Body> </Response> 訂單處理失敗： <Response service=”OrderService”> <Head>ERR</Head> <ERROR code="NNNN">錯誤詳細信息</ERROR> </Response> 3.2 訂單發貨確認 3.2.1 功能描述 該接口用于客戶在確定將貨物交付給順豐托運后，將運單上的一些重要信息，如快件重量、寄件時間，通過此接口發送給順豐。 3.2.2 接口主信息定義
3.2.3 可選字段信息
3.2.4 擴展字段信息 遵循擴展字段規范 3.2.5 應用場景XML實例 ² 場景1 場景描述： 請求 XML： <Request service=”OrderConfirmService” lang="zh-CN"> <Head>custid（客戶卡號）,checkwork（校驗碼）</Head> <Body> <OrderConfirm orderid=”訂單號” mailno=”運單號”> <OrderConfirmOption weight=”快件重量” volume=”托寄物的長，寬，高”/> <Extra e1=”擴展字段” e2=”擴展字段” e3=”擴展字段” e4=”擴展字段” e5=”擴展字段” e6=”擴展字 段” e7=”擴展字段” e8=”擴展字段” e9=”擴展字段” e10=”擴展字段” e11=”擴展字段” e12=”擴展字 段” e13=”擴展字段” e14=”擴展字段” e15=”擴展字段” e16=”擴展字段” e17=”擴展字段” e18=”擴展 字段” e19=”擴展字段” e20=”擴展字段”/> </OrderConfirm> </Body> </Request> 響應 XML： 訂單確認成功： <Response service=”OrderConfirmService”> <Head>OK</Head> <Body> <OrderConfirmResponse orderid=”訂單號” mailno=”運單號” remark=”備注”/> </Body> </Response> 訂單確認失敗： <Response service=”OrderConfirmService”> <Head>ERR</Head> <ERROR code="NNNN">錯誤詳細信息</ERROR> </Response> 3.3 訂單篩選 3.3.1 功能描述 客戶系統通過此接口向順豐企業服務平臺發送自動篩單請求，用于判斷客戶的收、派地址是否屬于順豐的收派范圍。系統會根據收派雙方的地址自動判斷是否在順豐的收派范圍內。如果屬于范圍內則返回可收派，否則返回不可收派。 3.3.2 接口主信息定義
3.3.3 可選字段信息
3.3.4 擴展字段信息 無。 3.3.5 應用場景 XML 實例 ² 場景1 場景描述： 請求XML： <Request service=”OrderFilterService” lang="zh-CN"> <Head>j_custid（客戶卡號）,checkwork（校驗碼）</Head> <Body> <OrderFilter filter_type=”篩單類別” orderid=”訂單號” d_address=”到件方地址”> <OrderFilterOption j_tel=”寄件方電話” j_address=”寄件方地址” d_tel=”到件方電話”/> </OrderFilter> <!--...//最多包括 5 個<OrderFiler>--> </Body> </Request> 響應 XML： 篩單處理成功： <Response service=”OrderFilterService”> <Head>OK</Head> <Body> <OrderFilterResponse orderid=”訂單號” filter_result=”是否可收派” origincode=”原寄地 代碼” destcode=”目的地代碼” remark=”備注”/> ... </Body> </Response> 篩單處理失敗： <Response service=”OrderFilterService”> <Head>ERR</Head> <ERROR code="NNN">錯誤詳細信息</ERROR> </Response> 3.4 人工篩選結果推送 3.4.1 功能描述 如果客戶通過訂單篩選接口得到的反饋結果為：3-待確認時，如果訂單篩選時，提供了訂單號且 apply_type=2，當完成人工篩單時，順豐系統將人工篩單的結果推送給客戶系統。 請客戶系統提供一個符合以下規范的 HTTP URL，以便順豐向客戶系統推送人工篩單數據。 1）順豐以HTTP POST的方式向客戶系統推送數據。 2）請求方法的編碼格式：“application/x-www-form-urlencoded; charset=UTF-8” 3）推送的篩單結果以XML格式，通過POST方式發送給客戶系統。 4）一個POST方法最多推送5條篩單數據。 5）對xml內容進行URL編碼（字符集為UTF-8）。 6）客戶系統在接收到請求后，需要先對收到的內容進行URL解碼，得到相應的XML。然后從XML中 獲取相應的篩單數據。 7）在客戶系統正確處理XML信息后，向順豐返回響應信息，考慮到處理的效率，篩單推送認為批 量成功或失敗。 3.4.2 接口主信息定義
3.4.3 可選字段信息 無 3.4.4 擴展字段信息 無 3.4.5 應用場景 XML 實例 ² 場景1 場景描述： 請求 XML： <Request service=”OrderFilterPushService”> <Head>OK</Head> <Body> <OrderFilterResult orderid=”訂單號” filter_result=”是否可收派” origincode=”原寄地代碼”destCode=”目的地代碼” remark=”備注”/> <!--...//最多包括 5 個<OrderFilterResult> --> </Body> </Request> 響應 XML： 成功響應： <Response service=”OrderFilterPushService”> <Head>OK</Head> </Response> 失敗響應： <Response service=”OrderFilterPushService”> <Head>ERR</Head> <ERROR code="NNNN">錯誤詳細信息</ERROR> </Response> 3.5 路由查詢 3.5.1 功能描述 提供客戶系統通過接口查詢客戶通過順豐承運的運單路由的功能，支持單個或批量運單路由查詢的功能，批量查詢中，最多不能超過10個運單號。同一批次，只允許查詢同一種語言的運單路由。 路由查詢接口支持兩類查詢方式： 1） 根據運單號查詢：查詢請求中提供客戶卡號與運單號，系統將驗證客戶卡號與所有請求運單號的歸屬關系，系統只返回具有正確歸屬關系的運單路由信息。 2） 根據訂單號查詢：查詢請求中提供客戶卡號與訂單號，系統將驗證客戶卡號與所有請求訂單號的歸屬關系，對于歸屬關系正確的訂單號，找到對應的運單號，然后返回訂單對應運單號的路由信息。適用于通過企業服務平臺下發過訂單的客戶。 3.5.2 接口主信息定義
3.5.3 可選字段信息 無 3.5.4 擴展字段信息 無 3.5.5 應用場景 XML 實例 ² 場景1 場景描述：根據運單號查詢 請求 XML： <Request service=”RouteService” lang="zh-CN"> <Head>custid（客戶卡號）,checkwork（校驗碼）</Head> <Body> <RouteRequest tracking_type=”查詢類別” tracking_number=”單號 1,單號 2,…,單號 n”/> </Body> </Request> 響應 XML： 路由查詢成功： <Response service=”RouteService”> <Head>OK</Head> <Body> <RouteResponse mailno=”運單號” orderid=”訂單號”> <Route accept_time=”路由發生時間” accept_address=”路由發生地點” remark=”詳細說明” opCode=”操作碼”/> <!--...//可包括多個<Route>--> </RouteResponse> <!--...//最多包括 10 個<RouteResponse>--> </Body> </Response> 路由查詢失敗： <Response service=”RouteService”> <Head>ERR</Head> <ERROR code="NNNN">錯誤詳細信息</ERROR> </Response> 失敗響應： <Response service=”RouteService”> <Head>ERR</Head> <ERROR code="NNNN">錯誤詳細信息</ERROR> </Response> 3.6 路由推送 3.6.1 功能描述 該接口用于向客戶系統定時推送運單的路由信息。需要客戶系統提供一個符合以下規范的HTTP URL，以便順豐向客戶系統推送路由數據。推送方式為增量推送，對于同一個運單的路由，不重復推送。 1） 順豐以HTTP POST的方式向客戶系統推送數據。 2） 請求方法的編碼格式：“application/x-www-form-urlencoded; charset=UTF-8” 3） 推送的路由數據以XML格式，通過POST方式發送給客戶系統。 4） 一個POST方法最多推送10條路由數據。 5） 對xml內容進行URL編碼（字符集為UTF-8）。 6） 客戶系統在接收到請求后，需要先對收到的內容進行URL解碼，得到相應的XML。然后從XML中獲取相應的路由信息。 在客戶系統正確處理XML信息后，向順豐返回響應信息，考慮到處理的效率，路由推送認為批量成功或失敗。 3.6.2 接口主信息定義
3.6.3 可選字段信息 無 3.6.4 擴展字段信息 無 3.6.5 應用場景 XML 實例 ² 場景1 場景描述： 請求 XML： <Request service=”RoutePushService” lang="zh-CN"> <Head>custid（客戶卡號）,checkwork（校驗碼）</Head> <Body> <WaybillRoute id=”路由編號” mailno=”運單號” orderid=”訂單號” accept_time=”路由發生時 間” accept_address=”路由發生地點” remark=”詳細說明” opcode=”操作碼”/> <!--//...最多 10 個<WaybillRoute>--> </Body> </Request> 響應 XML： <Response service=”RoutePushService”> <Head>OK</Head> </Response> 4 附錄 4.1 原因代碼表
世聯翻譯-讓世界自由溝通！專業的全球語言翻譯供應商，上海翻譯公司專業品牌。絲路沿線56種語言一站式翻譯與技術解決方案，專業英語翻譯、日語翻譯等文檔翻譯、同傳口譯、視頻翻譯、出國外派服務，加速您的全球交付。 世聯翻譯公司在北京、上海、深圳等國際交往城市設有翻譯基地，業務覆蓋全國城市。每天有近百萬字節的信息和貿易通過世聯走向全球！積累了大量政商用戶數據，翻譯人才庫數據，多語種語料庫大數據。世聯品牌和服務品質已得到政務防務和國際組織、跨國公司和大中型企業等近萬用戶的認可。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
