npm 包 nforget-api 使用教程

阅读时长 5 分钟读完

简介

nforget-api 是一个 Node.js 的第三方 npm 包,用于操作 andforget.com 的 API 接口,实现创建、获取与修改数据。andforget 是一项针对敏感数据的保护措施,用户可以通过我们的 API 快速简洁地在应用程序中实现自动删除数据的功能。

安装

使用 npm 安装,全局或者到项目中安装均可:

使用

使用 nforget-api 前,需要先在 andforget 注册并获取 API Key。

初始化

创建数据

获取数据

更新数据

删除数据

深入理解

nforget-api 包下的每个方法都是异步的,返回值是 Promise 对象,可通过 .then 或 async/await 等方式使用;

初始化

初始化中需要您输入 API Key 与 API Secret,这是您在 andforget 注册后获取的数据。由于 andforget 提供了开发者模式,您可在其中设置完成后可正式提交接入。

创建数据

创建数据需要用户提供数据内容、过期时间以及 MIME 类型信息,其中,数据内容可以是字符串、二进制数据(Buffer)。

获取数据

获取数据需要用户提供数据 ID 即可,如果该数据已经过期或者不存在,则将抛出相应异常。

更新数据

更新数据需要用户提供数据内容、过期时间以及 MIME 类型信息,不会更改原有数据的 ID,可以通过该 ID 获取到更新后的数据。

删除数据

删除数据,需要用户提供数据 ID,处理完成后数据将无法再次被访问。

示例代码

下面是使用 nforget-api 进行文件加解密的示例代码:

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

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

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

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

结束语

nforget-api 是一个非常好用的 Node.js 第三方开源库,可以快捷地处理 andforget.com 提供的 API 服务。希望本文能够让读者有所收获,帮助更多的开发者使用该库提高开发效率,保护数据安全。

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

纠错
反馈