首页>编程相关>其他源码
下载

报关单

该服务为自定义声明提供了通用接口，其中这些声明使用 WCO 声明模式表示。除了提交报关单之外，报关单服务还允许您修改和取消报关单。它还提供上传支持文件和发出到达通知的功能。

报关服务 API 的目标是：

  1. 收到希望作出声明的声明人的请求
  2. 验证请求负载是否符合架构 DMS WCO 3.6 架构
  3. 将请求传递到 CDS 后端
  4. 回复声明者，表明步骤 2 / 3 成功。

由于通知过程是异步的，此 API 对声明者的唯一响应是指示验证成功（或其他）并提交到 CDS 后端。

开发设置

  • 该微服务需要 mongoDB 4.+
  • 本地运行： sbt run默认运行在端口9820
  • 使用测试端点运行： sbt 'run -Dapplication.router=testOnlyDoNotUseInAppConf.Routes'

服务经理简介

海关申报服务可以使用以下配置文件从 Service Manager 本地运行：

个人资料详情命令描述
CUSTOMS_DECLARATION_ALL sm2 --启动 CUSTOMS_DECLARATION_ALL运行所有 CDS 应用程序。
CUSTOMS_INVENTORY_LINKING_EXPORTS_ALL sm2 --启动 CUSTOMS_INVENTORY_LINKING_EXPORTS_ALL运行所有 CDS 库存链接导出相关应用程序。
CUSTOMS_INVENTORY_LINKING_IMPORTS_ALL sm2 --启动 CUSTOMS_INVENTORY_LINKING_IMPORTS_ALL运行所有 CDS 库存链接导入相关应用程序。

运行测试

  • 运行单元测试： sbt test
  • 运行集成测试： sbt IntegrationTest/test
  • 运行单元和集成测试： sbt test IntegrationTest/test
  • 使用覆盖率报告运行单元和集成测试： ./run_all_tests.sh run_all_tests.sh
    运行clean scalastyle coverage test it:test coverageReport dependencyUpdates"

验收测试

要运行 CDS 验收测试，请参阅此处。

性能测试

要运行性能测试，请参阅此处。

API文档

有关海关申报 API 文档，请参阅此处。

报关具体路线

路径 - 以/customs-declarations为前缀的内部路线支持的方法描述
/customs-declarations/邮政提交声明的端点。
/customs-declarations/cancellation-requests邮政取消声明的端点。
/customs-declarations/amend邮政端点修改声明。
/customs-declarations/file-upload邮政提交文件上传的端点。
/customs-declarations/uploaded-file-upscan-notifications/clientSubscriptionId/:clientSubscriptionId邮政用于管理文件上传向上扫描通知的端点。
/customs-declarations/file-transmission-notify/clientSubscriptionId/:clientSubscriptionId邮政用于向海关通知提交文件上传通知的端点。
/customs-declarations/arrival-notification邮政提交到达通知声明的端点。

仅供测试的特定路线

小路支持的方法描述
/file-upload/test-only/all删除用于删除所有文件上传元数据的端点。

调用/文件上传

对 /file-upload 端点的请求可以包含 successRedirect 和 errorRedirect URL。这些都是非强制性的。如果同时包含成功和错误重定向，则将调用 upscan v2，否则调用 v1。

用于本地测试的有用 CURL 命令

链接到curl命令

用于生成包含架构和示例消息的 ZIP 文件的自定义 SBT 任务

有一个 SBT 任务zipWcoXsds ，它在打包阶段在/public/api/conf下生成一个包含每个版本的架构和示例消息的 ZIP 文件（因此在正常开发期间不会生成）。这些 ZIP 文件由 YAML 引用。这些引用呈现为指向已部署服务中生成的 ZIP 的 HTML 链接。

要在本地生成 zip 文件，请从项目根目录在命令行中运行以下命令： 

 sbt package

从api-subscription-fields服务查找fieldsId UUID

X-Client-ID标头以及应用程序上下文和版本用于调用api-subscription-fields服务以获取唯一的fieldsId UUID 以传递到后端请求。

请注意，获取fieldsId服务当前尚未被存根。

在api-subscription-fields中播种数据以进行本地端到端测试

确保api-subscription-fields服务正在端口9650上运行。然后运行以下curl命令。

请注意，给出的命令中以2.0版本为例，您应该插入随后将调用的报关 api 版本号。

请注意，值d65f2252-9fcf-4f04-9445-5971021226bb在给定的命令中用作示例，您应该插入适合您需要的 UUID 值。 

 curl -v -X PUT "http://localhost:9650/field/application/d65f2252-9fcf-4f04-9445-5971021226bb/context/customs%2Fdeclarations/version/2.0" -H "Cache-Control: no-cache" -H "Content-Type: application/json" -d '{ "fields" : { "callbackUrl" : "https://postman-echo.com/post", "securityToken" : "securityToken", "authenticatedEori": "ABC123" } }'

然后，我们必须手动重置fieldId字段以匹配下游服务所需的 id。在 mongo 命令窗口中，依次粘贴以下内容。 

 use api-subscription-fields

db.subscriptionFields.update(
    { "clientId" : "d65f2252-9fcf-4f04-9445-5971021226bb", "apiContext" : "customs/declarations", "apiVersion" : "2.0" },
    { $set:
        {"fieldsId" : "d65f2252-9fcf-4f04-9445-5971021226bb"}
    }
)

然后，当您向customs-declarations发送请求时，请确保您的 HTTP 标头X-Client-ID值为d65f2252-9fcf-4f04-9445-5971021226bb

多个 wco-dec 服务 - 基于 ACCEPT 标头的配置切换

开发者中心提供了该服务的三个版本。

每个版本都有单独的 MDG wco 声明端点配置部分，因此版本可能指向不同的后端服务。

在请求中提供所需的 ACCEPT 标头可以区分要使用的服务配置：

接受标头版本
应用程序/vnd.hmrc.1.0+xml v1
应用程序/vnd.hmrc.2.0+xml v2
应用程序/vnd.hmrc.3.0+xml v3

请注意，具有任何其他Accept标头值的请求都会被拒绝，并显示406 Not Acceptable响应状态。

切换服务端点

wco 声明连接器已实现服务端点的动态切换。要配置端点的动态切换，应用程序配置文件中必须有相应的部分（请参见下面的示例）。这应该包含端点配置详细信息。

例子

customs-declarations服务具有default配置和stub配置。请注意， default配置直接在customs-declarations部分内声明。 

 Prod {
    ...
    services {
      ...

      wco-declaration {
        host = some.host
        port = 80
        bearer-token = "some_token"
        context = /services/declarationmanagement/1.0.0

        stub {
          host = localhost
          port = 9479
          bearer-token = "some_stub_token"
          context = "/registrations/registerwithid/1.0.0"
        }
      }
      
      v2 {
        wco-declaration {
          host = some.host
          port = 80
          bearer-token = "some_token"
          context = /services/declarationmanagement/1.0.0
  
          stub {
            host = localhost
            port = 9479
            bearer-token = "some_stub_token"
            context = "/registrations/registerwithid/1.0.0"
          }
        }
      }
    }
}

切换端点的服务配置

要求

 default version (application/vnd.hmrc.1.0+xml):
curl -X "POST" http://customs-declarations-host/test-only/service/wco-declaration/configuration -H 'content-type: application/json' -d '{ "environment": "stub" }'

version 2 (application/vnd.hmrc.2.0+xml):
curl -X "POST" http://customs-declarations-host/test-only/service/v2.wco-declaration/configuration -H 'content-type: application/json' -d '{ "environment": "stub" }'

回复

 The service customs-declarations is now configured to use the stub environment

将端点的服务配置切换为默认值

要求

 curl -X "POST" http://customs-declarations-host/test-only/service/wco-declaration/configuration -H 'content-type: application/json' -d '{ "environment": "default" }'

回复

 The service customs-declarations is now configured to use the default environment

获取服务的当前配置

要求

 curl -X "GET" http://customs-declarations-host/test-only/service/wco-declaration/configuration

回复

 {
  "service": "wco-declaration",
  "environment": "stub",
  "url": "http://currenturl/customs-declarations"
  "bearerToken": "current token"
}

执照

此代码是根据 Apache 2.0 许可证授权的开源软件。

展开
附加信息
相关应用
为您推荐
相关资讯 全部