前言
在现代化的 Web 应用程序中,数据和 API 组成了基础。API 可以用来查询,修改和删除数据。访问 API 的方式有很多种,但是在 JavaScript 中,我们一般使用 Ajax/TLS 来发起网络请求以获取数据。然而,像 monobank 这样的机构需要更安全,更可靠的方法来保护其数据。为了解决这个问题,monobank 发布了一个 npm 包 - monobank-api-client。
本文将介绍 npm 包 monobank-api-client 的使用教程,并附带示例代码。
monobank-api-client 的介绍
monobank-api-client 是一个用于与 monobank Open API 交互的 Node.js 包。通过该包,开发者可以轻松访问和操作 monobank 的数据。
具体来说,当你使用该包时,你可以进行以下几个操作:
- 读取客户帐户和交易记录
- 获取客户货币汇率
- 获取客户限额和其他设置
安装 monobank-api-client
安装 monobank-api-client 包非常简单。只需要通过 npm 进行安装即可:
npm install monobank-api-client
使用 monobank-api-client
安装完成后,就可以使用 monobank-api-client 包了。首先,我们需要导入该包,并设置 API_key。
const MonobankAPI = require('monobank-api-client'); const api = new MonobankAPI({ token: 'my_secret_token', });
在这里,我们通过 require()
导入了 MonobankAPI,并定义了一个 API_key。请注意,这个 API_key 是必须的,并且是私密的。你只需要将上述代码中的 'my_secret_token' 替换为你自己的 API_key。你可以在 monobank 开发者文档中获得 API_key。
接下来,我们来尝试进行一些实际操作:
获得一个用户信息
我们可以使用 getPersonalInfo()
方法来获取用户的信息。例如,我们可以这样从 monobank 服务器获取用户帐户信息:
async function getPersonal() { const user = await api.getPersonalInfo(); console.log(user); } getPersonal();
获得交易记录
我们可以使用 getStatement()
方法来获取用户的交易记录。例如,我们可以这样获取最近 30 天的交易记录:
-- -------------------- ---- ------- ----- -------- -------------- - ----- ------------ - ----- ------------------ -------- -------------------------- ----- ----------- - ----------- - ----- --- ---------- - ---- --- -------------------------- - ---------------
在这里,我们提供了 "account"
参数,这个参数代表我们要查询哪个账户的交易数据。我们还指定了时间区间,以便仅获取最近 30 天的交易记录。
获得货币汇率
我们可以使用 getCurrencyRates()
方法来获取最新的货币汇率。例如,我们可以这样获取乌克兰格里夫纳 vs 几个主要货币的汇率:
async function getCurrency() { const rates = await api.getCurrencyRates({ currencyCodeA: 980, }); console.log(rates); } getCurrency();
在这里,我们提供了 "currencyCodeA"
参数,这个参数代表我们要查询哪种货币的汇率。我们获得的是乌克兰格里夫纳相对于其他主要货币的汇率。
总结
在本文中,我们学习了如何使用 monobank-api-client,它可以与 monobank Open API 交互,以获取用户帐户信息、交易记录和货币汇率信息。学习了如何安装和设置 node.js 包及如何使用基本 API 进行常见操作。希望这篇文章能够让你更好地理解和掌握 monobank-api-client 包的使用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006735b890c4f7277583f9a