NPM 包 node-red-contrib-aftership 使用教程

阅读时长 4 分钟读完

Node-RED 是流程编排工具,而 node-red-contrib-aftership 插件是一个可用于 Node-RED 的 AfterShip API 包装器。本篇文章将为大家介绍如何使用 node-red-contrib-aftership 插件来获取 AfterShip API 数据,并且提供详细的使用示例和指导。

1. 安装 node-red-contrib-aftership

首先需要确保已经安装了 Node-RED,如果没有请先安装。然后通过以下命令来安装 node-red-contrib-aftership:

2. 获取 AfterShip API Key

在使用 node-red-contrib-aftership 之前,需要先获取 AfterShip API Key,这是一个必要的身份凭证。可以前往 AfterShip 官网注册并登录账户,然后按照页面提示进行 API Key 获取。

3. 配置 node-red-contrib-aftership

在 Node-RED 的编辑器中,需要创建一个新的 Flow 并在其中加入 node-red-contrib-aftership 节点。然后单击该节点打开配置窗口,按照如下信息进行配置:

  • API Key:填入之前获取的 AfterShip API Key,
  • Language:设定 API 返回数据的语言,
  • Poll Interval:设定轮询数据的时间间隔(可选)。

4. 使用 node-red-contrib-aftership

在 node-red-contrib-aftership 中,共有 5 个节点可以使用,各自提供的功能如下:

  • aftership:获取单个快递运单详情
  • aftership-get-trackings:获取所有的快递运单数据
  • aftership-trackings-new-trackings:添加新的快递运单数据
  • aftership-trackings-update-tracking:更新已有的快递运单数据
  • aftership-trackings-delete-tracking:删除指定的快递运单数据

下面是一个简单的使用示例,获取 “zto” 快递公司的单个运单详情:

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

以上示例中,需要将 {YOUR_API_KEY}YOUR_TRACKING_NUMBER 分别替换为自己的 API Key 和 运单号码。

5. 结论

通过本文的介绍,相信各位已经了解了如何使用 node-red-contrib-aftership 插件在 Node-RED 中调用 AfterShip API,从而获取快递运单数据。希望本文对你有所启发,能够在日常的开发工作中带来借鉴和借助的地方。

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

纠错
反馈