npm 包 ups-shipping-api 使用教程

阅读时长 4 分钟读完

UPS 联合包裹服务(United Parcel Service)是美国的一家快递公司,也是全球运输和物流行业的领导者之一。UPS 提供巨大的规模和多样化的服务,为全球包裹和货物的运输、处理、跟踪和交货提供支持。为了方便前端开发者调用 UPS 的 API,开发者 edwardfhsiao 创建了 ups-shipping-api 这个 npm 包。

该包的主要功能是使用 UPS 的 API 获取货运数据,可以了解到运输的具体信息,如预计到达时间、运费和货运扫描状态等等。本篇文章将介绍该 npm 包的基本使用方法,同时给出一些使用该包时需要注意的问题,帮助读者更好地掌握该 npm 包的应用。

安装

使用 npm 安装 ups-shipping-api,需要先查看该 npm 包是否在 npm 上注册:

如果该命令可以找到包,就可以使用以下命令进行安装:

使用

在开始使用前,首先需要了解一下该包的 API。UPS 的 API 分为两类:REST API 和 SOAP API。SOAP API 是 UPS 的早期版本,目前已经被 UPS 禁用,所以 ups-shipping-api 选择使用 REST API。

在使用 ups-shipping-api 时,需要提供 UPS 的 Access Key、User Id 和 Password。这些信息可以在 UPS 开发者平台(https://www.ups.com/upsdeveloperkit)上获取。获取 Access Key 需要注册 UPS 开发者账号并创建应用。

-- -------------------- ---- -------
-- -- --- ---
----- --- - ---------------------------

-- --- --- ------
----- --- - --- -----
  ----------- ------------------
  -------- ---------------
  --------- ----------------
  ----- ------ -- ------ -- ------
--

-- ------
--------------------------------------
  ---------- -- -
    -----------------
  --
  ------------ -- -
    ------------------
  --

注意事项

在使用 ups-shipping-api 时,需要注意以下几个问题:

  1. Access Key、User Id 和 Password 必须正确,该信息可以在 UPS 开发者平台上获取。
  2. ups-shipping-api 只支持使用 UPS 的 REST API,因为 UPS 早期版本的 SOAP API 已经被禁用。
  3. 在获取 Track Response 时,需要使用正确的 Tracking Number。Track Request 中只能包含 Tracking Number 一个元素,所以不能传递多个 Tracking Number。
  4. 可以使用客户端模块进行请求,但不支持在浏览器中使用该包。

示例代码

-- -------------------- ---- -------
----- --- - ---------------------------

----- --- - --- -----
  ----------- ------------------
  -------- ---------------
  --------- ----------------
  ----- ------ -- ------ -- ------
--

-- ------
--------------------------------------
  ---------- -- -
    -----------------
  --
  ------------ -- -
    ------------------
  --

该代码使用 ups-shipping-api 包创建了 UPS 客户端实例,然后调用了 trackPackage 方法来获取包裹信息。如果获取成功,则会将响应数据打印出来;如果获取失败,则会将错误信息打印出来。使用该包,你可以更加方便地获取 UPS 的运输数据,为你的业务提供更好的支持。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f76238a385564ab68ca

纠错
反馈