WorldFirst DocsWorldFirst Docs

集成指南

本指南介绍集成流程的各步骤,请阅读本章节了解与 WorldTrade 集成的整体过程。

集成流程分为以下几个步骤:

  1. 集成准备
  2. 集成开发
  3. 完成验收测试
  4. 发布至生产环境

集成准备

阅读集成文档

在与万里汇集成前,集成商需阅读相关文档,了解对应方案的后续集成步骤,包括:

  • 集成指南(本文档)
  • API概览:了解报文传输结构,包括请求头和响应头结构等;
  • 生成签名及加验签:了解如何对请求加签、对响应验签以及签名示例;
  • API列表:了解可调用的具体接口、接口调用方向和具体业务用途;
  • 幂等字段:了解API调用时的幂等字段。

制定集成方案

集成商需联系万里汇技术支持并制定集成方案。

交换身份验证及其他信息

下表为集成商在两个不同环境(测试和生产环境)中集成需要向万里汇提供或获取的信息:

测试环境

生产环境

向万里汇获取

向万里汇提供

向万里汇获取

向万里汇提供

万里汇测试账户(包含买家和卖家账户)

按照生成签名及加验签文档生成的公钥

万里汇买家账户(可选)

按照生成签名及加验签文档生成的公钥

万里汇公钥

接受通知的域名

万里汇公钥

MID号

访问域名

调用IP

访问域名

/

clientId

/

clientId

表1. 集成商在测试和生产环境需要与万里汇交换的信息

集成开发

集成商可根据具体业务需求,与万里汇团队一起完成开发和集成,集成商可使用WorldTrade的API接口实现上传文件、创建订单、发起支付、查询订单详情、订单发货等功能。WorldTrade 解决方案部分接口具有依赖关系,建议集成商按照下述步骤进行集成开发。

下图展示了WorldTrade API集成的整体流程:

截屏2025-03-31 10.46.00.png

图1. API集成的整体流程

步骤一:上传文件

调用uploadAttachment接口,上传相应的商品图片、发货材料证明等文件。万里汇将返回相应的 fileKeyfileName 参数,用于创建订单、发货接口的参数传递。

如需后续调用createTradeOrder接口创建贸易订单,请在调用uploadAttachment接口时,入参bizType使用取值:WT_B2B_TRADE_PRODUCT

如需后续调用createDelivery接口创建发货订单,请在调用uploadAttachment接口时,入参bizType使用取值:WT_B2B_DELIVERY_LOGISTICSWT_B2B_DELIVERY_OTHERWT_B2B_DELIVERY_ENTRY

步骤二:创建贸易订单

集成商可调用createTradeOrder接口,上传贸易订单的相关详细信息,创建WorldTrade贸易订单。订单创建成功后,万里汇将返回订单链接及订单支付链接。

createTradeOrder接口入参requestId为幂等字段,每次调用需使用不同取值。

集成商如需集成通知接口,须在createTradeOrder接口的三个通知地址字段(payResultNotifyUrlorderResultNotifyUrldeliveryResultNotifyUrl 字段)中填写真实有效的通知URL。

若订单不符合万里汇风控要求,万里汇将通过notifyTradeOrderCloseResult接口,向集成商返回订单的关闭结果。

步骤三:查询订单详情

订单创建后,集成商可调用queryTradeOrder接口,查看订单详情,如:订单支付阶段(首尾款/全款)、订单支付结果信息、发货信息等。

步骤四:创建发货订单

根据步骤一以及步骤二的返回结果,集成商可调用createDelivery接口,创建发货请求。成功创建发货请求后,万里汇将返回发货批次单号信息。

createDelivery接口入参requestId为幂等字段,每次调用需使用不同取值。

万里汇将通过notifyDeliveryAuditResult接口,向集成商返回发货审核结果。

步骤五:接收并回应结果通知

集成商在调用创建订单接口时(步骤二),通过对 payResultNotifyUrl, orderResultNotifyUrldeliveryResultNotifyUrl 三个字段传送实际有效的通知地址,万里汇则会向集成商发送如下类型的通知:

在接收到万里汇通知后,集成商需要对通知进行响应,以确认信息收到,具体响应头信息请见:API 概览

在发送响应回执时,需要对回执进行加签,具体加签步骤请见:生成签名及加验签 章节。

完成验收测试

完成验收用例(由万里汇技术人员提供),产出集成报告,集成商需联系万里汇技术支持了解验收测试详情。

发布至生产环境

应用通过验收测试后,集成商即可切换至生产环境参数,如修改clientId、密钥等,并部署到生产环境。