README

我们的 API 使用基于 REST 的设计，利用 JSON 数据格式，并依赖 HTTPS 进行传输。我们以有意义的 HTTP 响应码进行响应，如果发生错误，将在响应体中包含错误详情。API 文档在 https://api.youneedabudget.com

此 PHP 包由 Swagger Codegen 项目自动生成

API 版本：1.0.0
包版本：1.0.0
构建包：io.swagger.codegen.languages.PhpClientCodegen

要求

PHP 7.1 及更高版本

安装 & 使用

Composer

要使用 Composer 安装绑定，请执行以下命令

$ composer require jorijn/ynab-sdk-php

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/YNAB-SDK-PHP/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装说明进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: bearer
$config = YNAB\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
$config = YNAB\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new YNAB\Client\AccountsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$budgetId = "budgetId_example"; // string | The ID of the Budget.  \"last-used\" can also be used to specify the last used budget.
$accountId = "accountId_example"; // string | The ID of the Account.

try {
    $result = $apiInstance->getAccountById($budgetId, $accountId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->getAccountById: ', $e->getMessage(), PHP_EOL;
}

?>

API 端点文档

所有 URI 都相对于 https://api.youneedabudget.com/v1

类	方法	HTTP 请求	描述
AccountsApi	getAccountById	GET /budgets/{budget_id}/accounts/{account_id}	单个账户
AccountsApi	getAccounts	GET /budgets/{budget_id}/accounts	账户列表
BudgetsApi	getBudgetById	GET /budgets/{budget_id}	单个预算
BudgetsApi	getBudgetSettingsById	GET /budgets/{budget_id}/settings	预算设置
BudgetsApi	getBudgets	GET /budgets	列出预算
CategoriesApi	getCategories	GET /budgets/{budget_id}/categories	列出类别
CategoriesApi	getCategoryById	GET /budgets/{budget_id}/categories/{category_id}	单个类别
MonthsApi	getBudgetMonth	GET /budgets/{budget_id}/months/{month}	单个预算月份
MonthsApi	getBudgetMonths	GET /budgets/{budget_id}/months	列出预算月份
PayeeLocationsApi	getPayeeLocationById	GET /budgets/{budget_id}/payee_locations/{payee_location_id}	单个收款人位置
PayeeLocationsApi	getPayeeLocations	GET /budgets/{budget_id}/payee_locations	列出收款人位置
PayeeLocationsApi	getPayeeLocationsByPayee	GET /budgets/{budget_id}/payees/{payee_id}/payee_locations	列出收款人的位置
PayeesApi	getPayeeById	GET /budgets/{budget_id}/payees/{payee_id}	单个收款人
PayeesApi	getPayees	GET /budgets/{budget_id}/payees	列出收款人
预交易API	getScheduledTransactionById	GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}	单个预交易
预交易API	getScheduledTransactions	GET /budgets/{budget_id}/scheduled_transactions	列出预交易
交易API	bulkCreateTransactions	POST /budgets/{budget_id}/transactions/bulk	批量创建交易
交易API	createTransaction	POST /budgets/{budget_id}/transactions	创建新交易
交易API	getTransactionById	GET /budgets/{budget_id}/transactions/{transaction_id}	单个交易
交易API	getTransactions	GET /budgets/{budget_id}/transactions	列出交易
交易API	getTransactionsByAccount	GET /budgets/{budget_id}/accounts/{account_id}/transactions	列出账户交易
交易API	getTransactionsByCategory	GET /budgets/{budget_id}/categories/{category_id}/transactions	列出类别交易
交易API	getTransactionsByPayee	GET /budgets/{budget_id}/payees/{payee_id}/transactions	列出收款人交易
交易API	updateTransaction	PUT /budgets/{budget_id}/transactions/{transaction_id}	更新现有交易
用户API	getUser	GET /user	用户信息

jorijn / ynab-sdk-php

维护者

详细信息

README

要求

安装 & 使用

Composer

手动安装

测试

入门

API 端点文档

模型文档

授权文档

bearer

作者