PyKuda

一个简化使用 Kuda Bank Api 的 python 包。虽然 Kuda Bank Api 非常易于使用，但这个 python 包可以无缝且轻松地享受 Kuda 美丽的 Open Api。PyKuda 使用 Kuda 的 Api v2，它使用 API 密钥和令牌进行身份验证。

入门

安装 PyKuda

要使用这个包，请使用包管理pip来安装 PyKuda。

pip install pykuda

PyKuda 有一些将被安装的依赖项（请求和 python-dotenv）。requestsPyKuda 使用它向 Kuda 的端点发出 http 请求，而python-dotenv负责获取必须为请求进行身份验证设置的环境变量；更多内容将在下面讨论。

创建环境变量

安装后，接下来就是创建.env存储环境变量的文件。文件中要设置五个变量.env，如下面的示例所示。

KUDA_KEY="Your Kuda Api Key"
TOKEN_URL="Kuda API v2 Get Token endpoint"
REQUEST_URL="Kuda API v2 Endpoint"
EMAIL="Your email used to register for the Kuda account"
MAIN_ACCOUNT_NUMBER="Your main Kuda account number"

注意：请确保不要将.env文件推送到公共存储库，因为此处的详细信息是保密的。

使用 PyKuda

from pykuda.pykuda import PyKuda

kuda = PyKuda()
response = kuda.get_bank_list()

# response contains PyKudaResponse which has the status code and data.

了解 PyKudaResponse

使用 Python 发出的每个请求都会被过滤并返回一个 PyKudaResponse，这个响应有两个属性，status_code和data.

请求成功

以上面的响应为例；

>>> response
>>> PyKudaResponse(status_code=200, data=[list_of_banks])

如上所示，PyKudaResponse 返回 status_code 和数据，数据是已经过滤的数据，您可以通过执行直接访问response.data。

请求失败

如果请求不成功，PyKudaResponse 会有所不同。数据将是一个 rRsponse 对象，您可以检查它以调查原因（可能您的令牌不正确，或者 URL 或其他东西。）。现在，假设 .env 文件中的 API 密钥不正确并且发出了请求，下面的示例显示了预期的响应。

>>> response
>>> PyKudaResponse(status_code=401, data=<Response [401]>)
>>>
>>> respose.data.text # 'Invalid Credentials'
>>> respose.data.reason # 'Unauthorized'

PyKuda 还能做什么？

PyKuda 也可以用来发出其他请求，如果您想了解更多关于如何使用 PyKuda 发出其他请求，请查看源代码。希望我能够改进此文档，以展示如何使用它来提出其他请求的示例。下面列出了 PyKuda 可以提出的请求列表。

BANK_LIST, ADMIN_CREATE_VIRTUAL_ACCOUNT, RETRIEVE_VIRTUAL_ACCOUNT_BALANCE, ADMIN_RETRIEVE_MAIN_ACCOUNT_BALANCE, FUND_VIRTUAL_ACCOUNT, WITHDRAW_VIRTUAL_ACCOUNT, NAME_ENQUIRY, SINGLE_FUND_TRANSFER, 和VIRTUAL_ACCOUNT_FUND_TRANSFER.

请参阅Kuda 的文档以了解有关这些请求的更多信息。

贡献和问题

• 如果您想贡献和改进这个包，请随时 fork 存储库，进行更改并打开拉取请求。
• 如果您遇到任何问题或错误，请打开一个问题。

作者

• Kayode TemiTope