简介
@innocells/unnax-client 是一款适用于前端的 npm 包,它提供了与 Unnax Open Banking API 通信的语法糖,让您更便捷地使用这个 API。本文将介绍如何安装和使用这个包,以及它的一些高级功能。
安装
@innocells/unnax-client 是一款 npm 包,因此您需要使用 npm 的命令安装:
npm install @innocells/unnax-client
安装完成后您就可以像使用其他 npm 包一样使用 @innocells/unnax-client 了。
使用
以下是一段使用 @innocells/unnax-client 的示例代码,仅供参考:
-- -------------------- ---- ------- ------ ----- ---- -------------------------- ----- ----- - --- ------- ------- ------------- ------- ---------------- --------- ------------------------------------ --- ----- ----------- - ----- ----------------------------------------------------------- -------------------------
上述代码首先引用了 @innocells/unnax-client 这个包,然后创建了一个 Unnax 实例,将 API key 和 secret 作为实参传给构造函数。之后示例使用了 Unnax 实例的 transactionsApi 属性调用了 getTransactionById 方法。
这里的 transaction 对象是 API 返回的,@innocells/unnax-client 将其转换为了方便读取的 JSON 格式。您可以根据 API 文档中的返回值来读取 transaction 对象的各项属性。
高级功能
除了基本的 API 调用外,@innocells/unnax-client 还提供了一些高级功能,可以更加灵活地使用 Unnax API。
上传和下载二进制数据
Unnax API 支持的一些接口返回的是二进制数据,如 PDF 格式的交易记录。为了方便处理这些数据,@innocells/unnax-client 提供了上传和下载二进制数据的方法。
以下代码示例演示了如何下载交易记录的 PDF 格式数据:
const pdfData = await unnax.transactionsApi.getTransactionPdf('transaction-id'); const pdfBlob = new Blob([pdfData], { type: 'application/pdf' }); const pdfUrl = URL.createObjectURL(pdfBlob); window.open(pdfUrl);
上述代码首先使用 transactionsApi 的 getTransactionPdf 方法来下载 PDF 格式数据,然后使用 Blob 对象将数据转换为 Blob 格式。最后使用 URL.createObjectURL 方法将 Blob 对象转换为 URL,并使用 window.open 方法在新窗口中打开 PDF。
类似的,@innocells/unnax-client 还提供了 uploadFile 和 deleteFile 两个方法,用于上传和删除二进制数据。
使用 Promise API
@innocells/unnax-client 所有的 API 都是异步 Promise API。这意味着您可以轻松地在 async 函数中使用它们:
async function fetchTransaction(transactionId) { const transaction = await unnax.transactionsApi.getTransactionById(transactionId); console.log(transaction); }
这里的 fetchTransaction 函数可中断执行并等待异步 API 调用完成后再继续执行下面的代码。
结语
本文简要介绍了 @innocells/unnax-client 这款 npm 包的安装和使用方法,以及其中的一些高级功能。希望这篇文章可以对您学习和使用此包有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066bc1967216659e2441ce