README

安装

通过 composer 安装包

composer require fintech-systems/yodlee-api

存储私钥和公钥

创建一个 /storage 目录，并将您的私钥复制到 /storage/private-key.pem。如果您想运行完整的测试套件，也请将 public-key.pem 复制到 /storage。

设置环境文件

将 .env.example 文件复制到 .env 并填写详细信息。

.env 文件内容

YODLEE_COBRAND_NAME=
YODLEE_COBRAND_LOGIN=
YODLEE_COBRAND_PASSWORD=
YODLEE_API_URL=
YODLEE_API_KEY=
YODLEE_USERNAME=

命令

命令列表

显示 API 密钥

✗ php artisan yodlee:api-key
+-----------------------------------------------+-------------+
| key                                           | createdDate |
+-----------------------------------------------+-------------+
| 00000000-00000000-0000-0000-0000-000000000000 | 2021-05-06  |
+-----------------------------------------------+-------------+

控制台命令

控制台命令包含主要 API 方法的一个子集。

yodlee:accounts                       Fetch a list of Yodlee accounts
yodlee:api-key                        Fetch a list of Yodlee API keys
yodlee:delete-user                    Delete an existing Yodlee user
yodlee:event-subscriptions            Fetch a list of subscribed notification events
yodlee:get-user                       Fetch details about a Yodlee user
yodlee:providers                      Fetch a list of Yodlee providers
yodlee:provider-accounts              Fetch a list of Yodlee provider accounts
yodlee:register-user                  Register a new Yodlee user
yodlee:subscribe                      Subscribe to DATA_UPDATES event notifications
yodlee:transactions                   Fetch a list of Yodlee transactions for a user
yodlee:unsubscribe                    Unsubscribe from DATA_UPDATES event notifications

测试

测试示例

vendor/bin/phpunit
vendor/bin/phpunit --testdox
vendor/bin/phpunit tests/ApiTest.php
vendor/bin/phpunit --filter it_can_generate_a_jwt_token tests/
ApiTest.php
XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html=tests/coverage-report

更新日志

请参阅更新日志了解最近的变化。

Laravel 特定配置

发布配置

php artisan vendor:publish --tag=yodlee-config

本地开发

确保您的 private-key.pem 和 public-key.pem 密钥存储在 /storage

事件订阅回调 URL 通常为 https://app_url/api/v1/event。

如果您正在进行本地开发，请在 .env 文件中添加一个临时 URL，例如：EVENT_CALLBACK_URL=my-app.eu-1.sharedwithexpose.com/api/v1/event

以上示例假设您正在使用 Expose。使用 Laravel Valet 启动 Expose 并使用此 URL，请执行以下操作

expose share --subdomain=my-app --server=eu-1 http://my-app.test

如果您正在测试现有项目，则更新现有项目的 composer.json 并按如下要求添加依赖项

"repositories": [
        ...
        ,
        {
            "type": "path",
            "url": "../yodlee-api"
        }
    ],

然后更新 composer

  composer require fintech-systems/yodlee-api:dev-main
...
  - Upgrading fintech-systems/yodlee-api (v0.0.17 => dev-main)
...
  - Removing fintech-systems/yodlee-api (v0.0.17)
  - Installing fintech-systems/yodlee-api (dev-main): Symlinking from ../yodlee-api
Generating optimized autoload files

许可证

MIT 许可证（MIT）。请参阅许可证文件了解更多信息。

需要帮助？

Yodlee ERD

要了解Yodlee数据结构的概览，请参阅此处

https://developer.yodlee.com/docs/api/1.1/Data_Model

Yodlee API参考

Yodlee开发者API参考可以在以下链接找到

https://developer.yodlee.com/api-reference

我在业余时间开发这个API，用于更大的项目。如果您联系我，我可能能够提供帮助或优先考虑某些功能。

eugene@fintechsystems.net +27823096710

金融科技系统 / yodlee-php-api

维护者

详细信息