README

此仓库包含 Express Statement 服务（https://rychlyvypis.cz/）的易于使用的 PHP 客户端。

先决条件

• PHP 7.1
• Express Statement 服务配置值（请联系我们以获取它们）
  • APP_KEY
  • APP_PRIVATE_KEY
  • SERVER_PUBLIC_KEY

安装

使用我们的 composer 包

composer require lime-company/express-statement-php

使用方法

您可以使用我们的客户端类轻松调用服务方法。

首先，您需要初始化客户端类

use Lime\ExpressStatement\Client\Client;

$client = new Client($APP_KEY, $APP_PRIVATE_KEY, $SERVER_PUBLIC_KEY);

传递给 Client 实例的值是直接从 Express Statement 服务接收的，不需要进行任何转换或处理

• $APP_KEY - 以 app_ 前缀开始的字符串。
• $APP_PRIVATE_KEY - Base64 编码的字符串，表示应用程序的私钥。
• $SERVER_PUBLIC_KEY - Base64 编码的字符串，表示服务器的公钥。

之后，您可以轻松调用方法。

启动会话

为了将您的客户与银行账户报表数据配对，您首先需要向我们服务请求一个临时配对账户（称为“会话”）。临时账户有效期为 30 分钟，或直到您删除所有连接。

$initResponse = $client->initExpressStatement();

响应包含

• $sessionId - 配对账户（会话）的标识符。不要将该值发送到前端应用程序。将其存储在内部，例如在会话中。
• $sessionPublicKey - 使用此密钥验证所有后续请求。不要将该值发送到前端应用程序，将其存储在内部，例如在会话中。
• $redirectId - 在浏览器重定向中使用此值。
• 技术属性

获取可用账户

在建立会话后，您可以查询该会话的连接状态。

$getBankListResponse = $client->fetchConnectedBankList($sessionId, $sessionPublicKey);

响应包含

• $banks - 与会话连接的银行。
• $availableBanks - 还可连接的银行。
• $expires - 会话过期时间和相关配对不再可用的时间戳。
• 技术属性

获取银行账户报表

在用户在 web 应用程序中连接一个或多个银行后，会话包含与这些银行的关联。现在，您可以按如下方式获取银行账户报表数据

$expressStatementResponse = $client->getExpressStatement($sessionId, $sessionPublicKey);

响应包含银行账户报表的结构化数据。您可以使用对象形式使用它，或者您可以存储数据以供以后使用

$json = $expressStatementResponse->serialize();

与单个银行解除配对

您可以通过提供银行的 BIC 值轻松从会话中断开任何银行

$client->deleteAllConnectionsForBank($sessionId, $bic, $sessionPublicKey);

删除会话

您还可以断开会话中的所有银行并清除会话

$client->deleteAllConnections($sessionId, $sessionPublicKey);

许可

本项目采用Apache 2.0许可协议。有关详细信息，请参阅LICENSE文件。

联系方式

如遇紧急情况，请使用support@lime-company.eu邮箱地址。