ynab api v1 python客户端
ynab-client的Python项目详细描述
ynab api v1 python客户端
我们的api使用基于rest的设计，利用json数据格式，并依赖https进行传输。我们用有意义的http响应代码进行响应，如果发生错误，我们会在响应体中包含错误详细信息。api文档位于https://api.youneedabudget.com
这个python包由Swagger Codegen项目自动生成：
- API版本：1.0.0
- 构建包：io.swagger.codegen.languages.pythonclientcodegen
要求。
python 2.7和3.4+
安装和使用
pip安装
如果python包托管在github上，则可以直接从github安装
pip install ynab-client
（您可能需要使用根权限运行pip：sudo pip install git+https://github.com/gchiam/ynab-client-python.git）
然后导入包：
importynab_client
设置工具
通过Setuptools安装。
python setup.py install --user
（或sudo python setup.py install为所有用户安装软件包）
然后导入包：
importynab_client
开始
请按照installation procedure操作，然后运行以下命令：
from__future__importprint_functionimporttimeimportynab_clientfromynab_client.restimportApiExceptionfrompprintimportpprint# Configure API key authorization: bearerconfiguration=ynab_client.Configuration()configuration.api_key_prefix['Authorization']='Bearer'configuration.api_key['Authorization']='YOUR_API_KEY'# create an instance of the API classapi_instance=ynab_client.BudgetsApi()try:api_response=api_instance.get_budgets()pprint(api_response)exceptApiExceptionase:print("Exception when calling BudgetApi->get_budgets: %s\n"%e)
API端点文档
所有uri都与https://api.youneedabudget.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AccountsApi | get_account_by_id | GET /budgets/{budget_id}/accounts/{account_id} | Single account |
| AccountsApi | get_accounts | GET /budgets/{budget_id}/accounts | Account list |
| BudgetsApi | get_budget_by_id | GET /budgets/{budget_id} | Single budget |
| BudgetsApi | get_budget_settings_by_id | GET /budgets/{budget_id}/settings | Budget Settings |
| BudgetsApi | get_budgets | GET /budgets | List budgets |
| CategoriesApi | get_categories | GET /budgets/{budget_id}/categories | List categories |
| CategoriesApi | get_category_by_id | GET /budgets/{budget_id}/categories/{category_id} | Single category |
| MonthsApi | get_budget_month | GET /budgets/{budget_id}/months/{month} | Single budget month |
| MonthsApi | get_budget_months | GET /budgets/{budget_id}/months | List budget months |
| PayeeLocationsApi | get_payee_location_by_id | GET /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location |
| PayeeLocationsApi | get_payee_locations | GET /budgets/{budget_id}/payee_locations | List payee locations |
| PayeeLocationsApi | get_payee_locations_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee |
| PayeesApi | get_payee_by_id | GET /budgets/{budget_id}/payees/{payee_id} | Single payee |
| PayeesApi | get_payees | GET /budgets/{budget_id}/payees | List payees |
| ScheduledTransactionsApi | get_scheduled_transaction_by_id | GET /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction |
| ScheduledTransactionsApi | get_scheduled_transactions | GET /budgets/{budget_id}/scheduled_transactions | List scheduled transactions |
| TransactionsApi | bulk_create_transactions | POST /budgets/{budget_id}/transactions/bulk | Bulk create transactions |
| TransactionsApi | create_transaction | POST /budgets/{budget_id}/transactions | Create new transaction |
| TransactionsApi | get_transactions | GET /budgets/{budget_id}/transactions | List transactions |
| TransactionsApi | get_transactions_by_account | GET /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions |
| TransactionsApi | get_transactions_by_category | GET /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions |
| TransactionsApi | get_transactions_by_id | GET /budgets/{budget_id}/transactions/{transaction_id} | Single transaction |
| TransactionsApi | get_transactions_by_payee | GET /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions |
| TransactionsApi | update_transaction | PUT /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction |
| UserApi | get_user | GET /user | User info |
型号文档
- Account
- AccountResponse
- AccountWrapper
- AccountsResponse
- AccountsWrapper
- BudgetDetailResponse
- BudgetDetailWrapper
- BudgetSettings
- BudgetSettingsResponse
- BudgetSettingsWrapper
- BudgetSummary
- BudgetSummaryResponse
- BudgetSummaryWrapper
- BulkIdWrapper
- BulkIds
- BulkResponse
- BulkTransactions
- CategoriesResponse
- Category
- CategoryGroup
- CategoryGroupsWrapper
- CategoryResponse
- CategoryWrapper
- CurrencyFormat
- DateFormat
- ErrorDetail
- ErrorResponse
- HybridTransactionsResponse
- HybridTransactionsWrapper
- MonthDetailResponse
- MonthDetailWrapper
- MonthSummariesResponse
- MonthSummariesWrapper
- MonthSummary
- Payee
- PayeeLocation
- PayeeLocationResponse
- PayeeLocationWrapper
- PayeeLocationsResponse
- PayeeLocationsWrapper
- PayeeResponse
- PayeeWrapper
- PayeesResponse
- PayeesWrapper
- SaveTransaction
- SaveTransactionWrapper
- ScheduledSubTransaction
- ScheduledTransactionResponse
- ScheduledTransactionSummary
- ScheduledTransactionWrapper
- ScheduledTransactionsResponse
- ScheduledTransactionsWrapper
- SubTransaction
- TransactionResponse
- TransactionSummary
- TransactionWrapper
- TransactionsResponse
- TransactionsWrapper
- User
- UserResponse
- UserWrapper
- BudgetDetail
- CategoryGroupWithCategories
- HybridTransaction
- MonthDetail
- ScheduledTransactionDetail
- TransactionDetail
授权文件
承载
- 类型：api键
- api密钥参数名：授权
- 位置：http头
欢迎加入QQ群-->： 979659372
