pluckypenguin / laravel-nordigen
Laravel 对 Nordigen 的 PHP 库的包装器。
Requires
- php: >=7.4
- ext-json: *
- guzzlehttp/guzzle: ^7.4
- nordigen/nordigen-php: ^1.0
- symfony/http-foundation: ^6.1
Requires (Dev)
- orchestra/canvas: ^6.10
README
本包提供了对 Nordigen PHP 库的包装,以便与 Nordigen 开放银行 API 交互。有关如何使用 API 和 PHP 库的详细信息,请访问此存储库 - nordigen/nordigen-php
安装
composer require pluckypenguin/laravel-nordigen
配置
此包装器允许通过在 .env 文件中添加以下配置选项来轻松自定义:
NORDIGEN_SECRET_ID
- 您的 Nordigen 应用程序密钥 IDNORDIGEN_SECRET_KEY
- 您的 Nordigen 应用程序密钥NORDIGEN_USE_SANDBOX
- 我们是否应该使用 Nordigen 沙盒提供者,还是实时提供者?NORDIGEN_DEFAULT_COUNTRY
- 当未提供时使用的默认国家代码。主要用于与机构交互。
您可以通过运行以下命令来发布本包提供的 Nordigen 配置文件:php artisan vendor:publish PluckyPenguin\LaravelNordigen\LaravelNordigenServiceProvider
使用方法
此包支持依赖注入,可以轻松访问 NordigenClient 类。
class MyNordigenController extends Controller { public function handleNordigenCallback(NordigenClient $nordigenClient) { // your code here... } }
或者,您可以使用此包提供的 Facade。
use PluckyPenguin\LaravelNordigen\Facades\NordigenClient; $accounts = NordigenClient::accounts->get();
最后,您可以使用从 .ENV 文件获取的设置来初始化 NordigenClient 类的实例:
$nordigenClient = app()->make(\Nordigen\NordigenPHP\API\NordigenClient::class);
中间件
本包包含一个中间件,您可以使用它来确保已登录应用程序的用户始终有一个活动的 Nordigen API 会话。要将此中间件包含在路由中,请使用 auth.nordigen
中间件。
用户特性
为了帮助您充分利用本包,有一个名为 HasNordigenApiToken
的用户特性,它提供了访问和刷新令牌的简单访问。为了使用本包提供的特性,您需要运行迁移 - php artisan migrate
。这将向您的 users
表添加 4 个新列 - nordigen_access_token
、nordigen_access_expires
、nordigen_refresh_token
和 nordigen_refresh_expires
。
贡献
请随时添加问题和创建拉取请求来解决您可能遇到的问题,以及添加任何缺失的功能。