README

Okra 的 PHP 包装器 Okra

要求

• guzzlehttp/guzzle: ~6.0
• PHP 7.0 或更高版本

安装

通过 Composer

$ composer require mmuodev/okra-php-wrapper

使用方法

此包装器提供了一个简单接口来使用 Okra 的核心产品 - 身份验证、身份、余额和交易。每个产品都由其自己的特质表示。您需要初始化 Client 类（并传递您的 Okra 托管令牌），以访问这些特质的属性。所有方法都返回一个数组，因此很容易在您的应用程序中使用。

$client = new Client(BEARER_TOKEN)

1. 身份验证

Okra 为客户提供了成功验证其银行的方法。客户输入其凭据，并立即进行身份验证。

a. 获取所有身份验证

这返回所有客户的身份验证信息，以数组或 PDF 格式。

$client->getAllAuth();

可选：传递布尔值 true 以返回 PDF 格式的数据

b. 获取特定客户身份验证

这通过身份验证 ID 返回客户的身份验证信息

$client->getAuthById();

必需：传递 身份验证 ID

c. 通过客户 ID 获取身份验证

这通过客户 ID 返回客户的身份验证信息

$client->getAuthByCustomerId();

必需：传递 客户 ID

d. 通过日期范围获取身份验证

这基于创建的日期范围返回身份验证信息

$client->getAuthByDateRange(from, to);

方法期望 5 个参数 - 前两个是必需的，而最后三个是可选的。前两个参数 - from 和 to 是日期范围，格式为 2020-05-10。
传递布尔值 true 给第三个参数以返回所有记录。忽略以返回一页。
倒数第二个和最后一个参数 - page 和 limit 是整数，表示要返回的 page 号和此页面上要返回的记录数 - limit。如果您正在获取所有记录，请忽略这些。

例如，要获取 2020-05-01 和 2020-05-20 之间的所有身份验证记录，您可以这样操作

$client->getAuthByDateRange('2020-05-01', '2020-05-20', true)

要获取与上述相同日期范围内的第 2 页，并且将记录数限制为 10 条，您可以这样操作

$client->getAuthByDateRange('2020-05-01', '2020-05-20', ,2,10)

2. 交易

接收客户授权的交易数据，包括当前账户、储蓄账户和托管账户。

a. 获取所有交易

这以数组或 PDF 格式返回交易的摘要信息。

$client->getTransactions();

可选：传递布尔值 true 以返回 PDF 格式的数据

b. 获取特定客户的交易

这返回特定客户的交易

$client->getTransactionsPerCustomer(customer_id);

方法期望 4 个参数 - 第一个必需，最后三个可选。第一个 - customer_id 是上一个方法返回的客户的 id。
传递布尔值 true 给第二个参数以返回所有记录。忽略以返回一页。
倒数第二个和最后一个参数 - page 和 limit 是整数，表示要返回的 page 号和此页面上要返回的记录数 - limit。如果您正在获取所有记录，请忽略这些。

c. 通过日期范围获取交易

这根据日期范围过滤交易

$client->getTransactionsByDateRange();

方法期望 5 个参数 - 前两个是必需的，而最后三个是可选的。前两个参数 - from 和 to 是日期范围，格式为 2020-05-10。
传递布尔值 true 给第三个参数以返回所有记录。忽略以返回一页。
倒数第二个和最后一个参数 - page 和 limit 是整数，表示要返回的 page 号和此页面上要返回的记录数 - limit。如果您正在获取所有记录，请忽略这些。

例如，要获取 2020-05-01 和 2020-05-20 之间的所有交易记录，您可以这样操作

$client->getTransactionsByDateRange('2020-05-01', '2020-05-20', true)

要获取与上述相同日期范围内的第 2 页，并且将记录数限制为 10 条，您可以这样操作

$client->getTransactionsByDateRange('2020-05-01', '2020-05-20', ,2,10)  

d. 按银行获取交易

这根据银行过滤交易

$client->getTransactionsPerBank(bank_id);

方法期望 4 个参数 - 第一个必需，最后三个可选。第一个 - bank_id 是银行的 id。每个银行都有一个唯一的 id。
传递布尔值 true 给第二个参数以返回所有记录。忽略以返回一页。
倒数第二个和最后一个参数 - page 和 limit 是整数，表示要返回的 page 号和此页面上要返回的记录数 - limit。如果您正在获取所有记录，请忽略这些。

e. 获取消费模式

这通过客户 ID 返回客户的消费模式

$client->getSpendingPatternPerCustomer(customer_id);

必需：传递 客户 ID

3. 身份

从银行文件中检索各种账户持有者信息，包括姓名、电子邮件、电话号码和地址

a. 获取所有身份信息

此操作以数组或PDF格式返回所有客户的身份信息。

$client->getIdentities();

可选：传递布尔值 true 以返回 PDF 格式的数据

b. 使用id获取客户的身份信息

此操作使用从上述方法返回的id返回身份信息。

$client->getIdentityById(id);

必需：传递身份id

c. 使用customer id获取客户的身份信息

此操作使用客户id返回客户的身份信息。

$client->getIdentityByCustomerId(customer_id);

必需：传递customer_id

d. 按日期范围获取身份信息

此操作基于创建日期范围返回身份信息。

$client->getIdentityByDateRange(from, to);

方法期望 5 个参数 - 前两个是必需的，而最后三个是可选的。前两个参数 - from 和 to 是日期范围，格式为 2020-05-10。
传递布尔值 true 给第三个参数以返回所有记录。忽略以返回一页。
倒数第二个和最后一个参数 - page 和 limit 是整数，表示要返回的 page 号和此页面上要返回的记录数 - limit。如果您正在获取所有记录，请忽略这些。

例如，要获取2020-05-01和2020-05-20之间的所有记录，您可以这样操作

$client->getIdentityByDateRange('2020-05-01', '2020-05-20', true)

要获取与上述相同日期范围内的第 2 页，并且将记录数限制为 10 条，您可以这样操作

$client->getIdentityByDateRange('2020-05-01', '2020-05-20', ,2,10)

4. 余额

检索每个账户记录的实时余额。

a. 获取所有余额

此操作以数组或PDF格式返回所有客户的余额信息。

$client->getAllBalance();

可选：传递布尔值 true 以返回 PDF 格式的数据

b. 使用id获取客户的余额信息

此操作使用从上述方法返回的id返回余额信息。

$client->getBalanceById(id);

必需：传递余额id

c. 使用customer id获取客户的余额信息

此操作使用客户id返回客户的余额信息。

$client->getBalanceByCustomerId(customer_id);

必需：传递customer_id

d. 按日期范围获取余额信息

此操作基于创建日期范围返回余额信息。

$client->getBalanceByDateRange(from, to);

方法期望 5 个参数 - 前两个是必需的，而最后三个是可选的。前两个参数 - from 和 to 是日期范围，格式为 2020-05-10。
传递布尔值 true 给第三个参数以返回所有记录。忽略以返回一页。
倒数第二个和最后一个参数 - page 和 limit 是整数，表示要返回的 page 号和此页面上要返回的记录数 - limit。如果您正在获取所有记录，请忽略这些。

例如，要获取2020-05-01和2020-05-20之间的所有记录，您可以这样操作

$client->getBalanceByDateRange('2020-05-01', '2020-05-20', true)

要获取与上述相同日期范围内的第 2 页，并且将记录数限制为 10 条，您可以这样操作

$client->getBalanceByDateRange('2020-05-01', '2020-05-20', ,2,10)

信贷

Obioha Uche