1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-11 05:32:39 +01:00
invoiceninja/app/Helpers/Bank/Yodlee/Yodlee.php

254 lines
6.4 KiB
PHP
Raw Normal View History

2022-07-28 06:09:13 +02:00
<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2022. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://www.elastic.co/licensing/elastic-license
*/
2022-07-28 07:07:35 +02:00
namespace App\Helpers\Bank\Yodlee;
2022-07-28 06:09:13 +02:00
2022-08-11 04:39:43 +02:00
use App\Exceptions\YodleeApiException;
2022-08-08 01:15:31 +02:00
use App\Helpers\Bank\Yodlee\Transformer\AccountTransformer;
2022-08-08 04:46:41 +02:00
use App\Helpers\Bank\Yodlee\Transformer\IncomeTransformer;
2022-07-28 07:07:35 +02:00
use Illuminate\Support\Facades\Http;
2022-08-10 03:56:46 +02:00
use Illuminate\Support\Str;
2022-07-28 07:07:35 +02:00
2022-07-28 06:09:13 +02:00
class Yodlee
{
2022-08-08 00:26:27 +02:00
public bool $test_mode = false;
2022-07-28 07:07:35 +02:00
2022-08-05 05:45:53 +02:00
private string $api_endpoint = 'https://production.api.yodlee.com/ysl';
2022-07-28 07:07:35 +02:00
2022-08-10 03:56:46 +02:00
// private string $test_api_endpoint = 'https://sandbox.api.yodlee.com/ysl';
private string $test_api_endpoint = 'https://development.api.yodlee.com/ysl';
2022-07-28 07:07:35 +02:00
2022-08-10 03:56:46 +02:00
//public string $test_fast_track_url = 'https://fl4.sandbox.yodlee.com/authenticate/restserver/fastlink';
public string $test_fast_track_url = 'https://fl4.preprod.yodlee.com/authenticate/USDevexPreProd3-449/fastlink?channelAppName=usdevexpreprod3';
public string $production_track_url = 'https://fl4.prod.yodlee.com/authenticate/USDevexProd3-331/fastlink?channelAppName=usdevexprod3';
2022-07-28 07:07:35 +02:00
protected string $client_id;
protected string $client_secret;
protected string $admin_name;
2022-08-08 00:26:27 +02:00
protected ?string $bank_account_id;
public function __construct(?string $bank_account_id = null)
2022-07-28 07:07:35 +02:00
{
2022-08-08 00:26:27 +02:00
$this->bank_account_id = $bank_account_id;
2022-07-28 07:07:35 +02:00
$this->client_id = config('ninja.yodlee.client_id');
$this->client_secret = config('ninja.yodlee.client_secret');
$this->admin_name = config('ninja.yodlee.admin_name');
2022-08-15 22:03:12 +02:00
$this->test_mode = config('ninja.yodlee.test_mode');
2022-07-28 07:07:35 +02:00
}
2022-08-10 03:56:46 +02:00
public function getFastTrackUrl()
{
return $this->test_mode ? $this->test_fast_track_url : $this->production_track_url;
}
2022-08-08 00:26:27 +02:00
public function setTestMode()
{
$this->test_mode = true;
return $this;
}
public function getEndpoint()
{
return $this->test_mode ? $this->test_api_endpoint : $this->api_endpoint;
}
/**
* If we do not pass in a user
* we pass in the admin username instead
*/
public function getAccessToken($is_admin = false)
2022-07-28 06:09:13 +02:00
{
2022-08-08 00:26:27 +02:00
if($is_admin)
2022-07-28 09:33:47 +02:00
$user = $this->admin_name;
2022-08-08 00:26:27 +02:00
else
$user = $this->bank_account_id ?: $this->admin_name;
2022-07-28 09:33:47 +02:00
$response = $this->bankFormRequest('/auth/token', 'post', [], ['loginName' => $user]);
2022-08-11 04:39:43 +02:00
2022-07-28 08:29:42 +02:00
return $response->token->accessToken;
}
2022-08-10 03:56:46 +02:00
public function createUser($company)
2022-07-28 08:29:42 +02:00
{
2022-07-28 09:33:47 +02:00
2022-08-08 00:26:27 +02:00
$token = $this->getAccessToken(true);
2022-07-28 08:29:42 +02:00
$user['user'] = [
2022-08-10 03:56:46 +02:00
'loginName' => Str::uuid(),
2022-07-28 08:29:42 +02:00
];
2022-08-06 08:58:48 +02:00
/*
{
"user": {
"preferences": {
"dateFormat": "string",
"timeZone": "string",
"currency": "USD",
"locale": "en_US"
},
"address": {
"zip": "string",
"country": "string",
"address3": "string",
"address2": "string",
"city": "string",
"address1": "string",
"state": "string"
},
"loginName": "string",
"name": {
"middle": "string",
"last": "string",
"fullName": "string",
"first": "string"
},
"email": "string",
"segmentName": "string"
}
}
*/
2022-08-08 00:26:27 +02:00
$response = Http::withHeaders($this->getHeaders(["Authorization" => "Bearer {$token}"]))->post($this->getEndpoint(). "/user/register", $user);
2022-08-06 08:58:48 +02:00
if($response->successful())
return $response->object();
if($response->failed())
2022-08-11 04:39:43 +02:00
throw new YodleeApiException($response->body());
2022-07-28 08:29:42 +02:00
2022-07-28 07:07:35 +02:00
}
2022-08-08 00:26:27 +02:00
public function getAccounts($params = [])
2022-07-28 09:33:47 +02:00
{
2022-08-08 00:26:27 +02:00
$token = $this->getAccessToken();
$response = Http::withHeaders($this->getHeaders(["Authorization" => "Bearer {$token}"]))->get($this->getEndpoint(). "/accounts", $params);
2022-08-05 05:45:53 +02:00
2022-08-08 01:15:31 +02:00
if($response->successful()){
$at = new AccountTransformer();
return $at->transform($response->object());
2022-08-05 05:45:53 +02:00
2022-08-11 04:39:43 +02:00
}
2022-08-05 05:45:53 +02:00
2022-08-11 06:19:35 +02:00
if($response->failed())
throw new YodleeApiException($response->body());
}
public function deleteAccount($account_id)
{
$token = $this->getAccessToken();
$response = Http::withHeaders($this->getHeaders(["Authorization" => "Bearer {$token}"]))->delete($this->getEndpoint(). "/accounts/{$account_id}", []);
if($response->successful()){
return true;
}
2022-07-28 09:33:47 +02:00
2022-08-11 04:39:43 +02:00
if($response->failed())
throw new YodleeApiException($response->body());
2022-07-28 09:33:47 +02:00
}
2022-08-11 06:19:35 +02:00
2022-08-08 00:26:27 +02:00
public function getTransactions($params = [])
2022-07-30 04:10:42 +02:00
{
2022-08-08 00:26:27 +02:00
$token = $this->getAccessToken();
2022-07-30 04:10:42 +02:00
2022-08-08 00:26:27 +02:00
$response = Http::withHeaders($this->getHeaders(["Authorization" => "Bearer {$token}"]))->get($this->getEndpoint(). "/transactions", $params);
2022-07-30 04:10:42 +02:00
2022-08-08 04:46:41 +02:00
if($response->successful()){
// return $response->object();
$it = new IncomeTransformer();
return $it->transform($response->object());
}
2022-08-05 05:45:53 +02:00
if($response->failed())
2022-08-11 04:39:43 +02:00
throw new YodleeApiException($response->body());
2022-07-30 04:10:42 +02:00
}
2022-08-08 00:26:27 +02:00
public function getTransactionCategories($params = [])
2022-07-28 07:07:35 +02:00
{
2022-08-08 00:26:27 +02:00
$token = $this->getAccessToken();
2022-07-28 07:07:35 +02:00
2022-08-08 00:26:27 +02:00
$response = Http::withHeaders($this->getHeaders(["Authorization" => "Bearer {$token}"]))->get($this->getEndpoint(). "/transactions/categories", $params);
2022-07-28 08:29:42 +02:00
if($response->successful())
return $response->object();
if($response->failed())
2022-08-11 04:39:43 +02:00
throw new YodleeApiException($response->body());
2022-07-28 08:29:42 +02:00
}
2022-07-28 09:33:47 +02:00
private function bankFormRequest(string $uri, string $verb, array $data = [], array $headers)
2022-07-28 08:29:42 +02:00
{
2022-08-08 00:26:27 +02:00
$response = Http::withHeaders($this->getFormHeaders($headers))->asForm()->{$verb}($this->getEndpoint() . $uri, $this->buildBody());
2022-07-28 07:07:35 +02:00
if($response->successful())
return $response->object();
if($response->failed())
2022-08-11 04:39:43 +02:00
throw new YodleeApiException($response->body());
2022-07-28 07:07:35 +02:00
}
private function getHeaders($data = [])
{
return array_merge($data, [
'Api-Version' => '1.1',
2022-07-28 08:29:42 +02:00
'ContentType' => 'application/json'
]);
}
private function getFormHeaders($data = [])
{
return array_merge($data, [
'Api-Version' => '1.1',
2022-07-28 07:07:35 +02:00
]);
}
private function buildBody()
{
return [
'clientId' => $this->client_id,
'secret' => $this->client_secret,
];
2022-07-28 06:09:13 +02:00
}
}