npm 包 khipu-got 使用教程

阅读时长 6 分钟读完

简介

khipu-got 是一个可以用于发送 HTTP 请求的 npm 包,它使用了 got 这个现成的库,并提供了一些用于方便使用 Khipu API 的函数。

Khipu API 是一个在线支付平台,提供了付款和收款的服务,可以方便地集成到网站和应用程序中。使用 khipu-got 可以更加方便高效地与 Khipu API 进行交互。

安装

安装 khipu-got 非常简单,只需要在终端中运行下面的命令即可:

使用方法

在使用 khipu-got 发送请求之前,您需要先获得 Khipu API 的 credentials,包括 API key 和 secret key。然后,您需要创建一个 khipu-got 的实例,并设置您的 credentials。

使用 khipu-got 的主要方法是 request。这个方法接收一个对象作为参数,包含了 HTTP 请求的各种属性和参数。其中最重要的属性是 endpoint,它指定了要请求的 API 的地址。

下面是一个简单的例子,演示如何使用 khipu-got 请求 Khipu API 的 banks 接口。

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

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

除了 endpointmethod,您还可以在 options 对象中指定其他属性,例如:

  • headers:请求头信息。
  • query:查询参数。
  • body:请求体内容。
  • json:设置为 true 表示请求体是 JSON 格式,khipu-got 会自动将它转换为对应的字符串。
  • form:设置为 true 表示请求体是表单形式,khipu-got 会自动将它转换为对应的字符串。
  • timeout:请求超时时间,单位是毫秒。
  • retry:在请求失败时是否自动重试,默认是 true。
  • maxRetries:重试的最大次数。
  • backoff:重试的时间间隔,是一个返回时间值的函数。

khipu-got 还提供了一些方便的方法来简化与 Khipu API 的交互。

方法

getBanks()

这个方法发送了一个 GET 请求,获取了 Khipu API 的 banks 接口返回的所有银行信息。它返回一个 Promise,Promise 的结果是一个包含银行信息的数组。

createPayment(options)

这个方法发送了一个 POST 请求,创建了一个新的付款请求。它接收一个包含付款信息的对象作为参数,这个对象的属性有:

  • subject:付款的主题,是一个字符串。
  • amount:付款金额,是一个数字。
  • payerEmail:付款人的电子邮件地址,是一个字符串。
  • bankId:指定使用的银行 ID,是一个字符串。
  • expiresDate:付款的截止日期,是一个 Date 对象。

该方法返回一个 Promise,Promise 的结果是一个包含付款请求信息的对象。

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

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

getPayment(paymentId)

这个方法发送了一个 GET 请求,获取了指定 ID 的付款请求的信息。它接收一个字符串作为参数,表示付款请求的 ID。

该方法返回一个 Promise,Promise 的结果是一个包含付款请求信息的对象。

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

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

confirmPayment(paymentId)

这个方法发送了一个 POST 请求,确认了指定 ID 的付款请求。

它接收一个字符串作为参数,表示付款请求的 ID。

该方法返回一个 Promise,Promise 的结果是一个包含确认信息的对象。

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

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

cancelPayment(paymentId)

这个方法发送了一个 POST 请求,取消了指定 ID 的付款请求。

它接收一个字符串作为参数,表示付款请求的 ID。

该方法返回一个 Promise,Promise 的结果是一个包含取消信息的对象。

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

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

结语

khipu-got 是一个方便高效的 npm 包,可以使您更加轻松地与 Khipu API 进行交互。

本篇文章介绍了 khipu-got 的安装和使用方法,并演示了一些常用的操作。

希望这篇文章对您有帮助!

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

纠错
反馈