世联翻译公司完成公司系统规范中文翻译
时间: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种语言一站式翻译与技术解决方案，专业英语翻译、日语翻译等文档翻译、同传口译、视频翻译、出国外派服务，加速您的全球交付。 世联翻译公司在北京、上海、深圳等国际交往城市设有翻译基地，业务覆盖全国城市。每天有近百万字节的信息和贸易通过世联走向全球！积累了大量政商用户数据，翻译人才库数据，多语种语料库大数据。世联品牌和服务品质已得到政务防务和国际组织、跨国公司和大中型企业等近万用户的认可。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
