npm 包 hunterio-sdk 使用教程

阅读时长 6 分钟读完

一、前言

在前端开发中,我们经常需要使用到第三方 API 来完成一些复杂的功能,而 Hunter.io 是一款提供邮箱搜索服务的知名网站,其中的 API 也备受开发者的青睐。本文将介绍如何使用 npm 包 hunterio-sdk 来访问 Hunter.io 的 API,以及如何在前端页面中使用它。

二、安装 hunterio-sdk

首先,我们需要使用 npm 来下载和安装 hunterio-sdk,打开你的命令行终端(Windows 用户可以使用 PowerShell,macOS 和 Linux 用户则直接使用终端),输入以下命令:

这时,npm 会下载并安装 hunterio-sdk 及其依赖包,下载完成后就可以在项目中使用它了。

三、获取 Hunter.io API Key

在使用 hunterio-sdk 前,我们需要先在 Hunter.io 的网站上注册账号并获取 API Key,步骤如下:

  1. 打开 Hunter.io 的官方网站
  2. 点击右上角的「Start for Free」按钮,注册一个新账号并登录;
  3. 在网站的右上角,点击「Account」->「API」,即可看到你的 API Key。

四、使用 hunterio-sdk

安装好 hunterio-sdk 和获取到 API Key 后,我们就可以使用它了。

1. 创建 Hunterio 对象

首先,在你的 JavaScript 文件中,需要先引入 hunterio-sdk:

然后,利用 API Key 创建一个 Hunterio 对象:

2. 查询邮箱信息

接下来,我们就可以使用 Hunterio 对象提供的方法来查询邮箱信息了。

1. 查询某个邮箱的详细信息

在查询某个邮箱的详细信息时,hunterio-sdk 会返回一个 Promise 对象,我们可以使用 async/await 或 .then() 方法来获取查询结果。

查询结果将包含以下信息:

  • value:邮箱地址
  • status:邮箱状态,可能的值为「deliverable」、「undeliverable」、「risky」、「unknown」
  • score:信誉分,建议将分值与漏洞、滥发垃圾邮件相关联
  • firstName:名字,可选
  • lastName:姓氏,可选
  • fullName:姓名,可选
  • position:职位,可选
  • seniority:职史,可选
  • department:所在部门,可选
  • linkedin:该用户的 Linkedin 资料链接,可选
  • twitter:该用户的 Twitter 资料链接,可选

2. 查询某个公司的所有邮箱

在查询某个公司的所有邮箱时,hunterio-sdk 也会返回一个 Promise 对象,查询结果将包含该公司所有邮箱的地址。

3. 查询某个邮箱的验证状态

在查询某个邮箱的验证状态时,hunterio-sdk 也会返回一个 Promise 对象,查询结果将包含以下信息:

  • value:邮箱地址
  • deliverability:交付状态,可能的值为「deliverable」、「undeliverable」、「risky」、「unknown」
  • score:信誉分,范围为 0 到 10 分
  • source:邮箱验证来源
  • pattern:验证的模式

五、示例代码

接下来,我们将使用上述方法来实现一个查询公司所有邮箱的前端页面。

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

在 HTML 文件中,我们定义了一个表单用于输入查询的公司,以及一个无序列表用于展示查询结果。

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

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

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

在 JavaScript 文件中,我们先引入 hunterio-sdk,然后创建一个 Hunterio 对象。在查询邮箱方法中,我们首先获取到用户输入的公司域名,然后调用 hunterio-sdk 的 domain 方法查询该公司所有邮箱地址。由于查询结果可能为空,因此我们使用 try...catch... 语句捕获异常,同时使用 DOM 操作在页面中展示查询结果。

六、总结

本文介绍了如何使用 npm 包 hunterio-sdk 访问 Hunter.io 的 API,以及如何在前端页面中使用它。在学习和使用 hunterio-sdk 时,需要注意安全问题,避免恶意使用该 API,造成不必要的麻烦。

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

纠错
反馈