From 0f419aef37da8d508f7228eee4763fd1975f133d Mon Sep 17 00:00:00 2001 From: Naoki Kuroda Date: Tue, 2 Sep 2014 18:08:46 +0900 Subject: [PATCH] Update api-referrence.md --- api-referrence.md | 142 ++++++++++++++++++++++++---------------------- 1 file changed, 74 insertions(+), 68 deletions(-) diff --git a/api-referrence.md b/api-referrence.md index 14a28b9..b2011f1 100644 --- a/api-referrence.md +++ b/api-referrence.md @@ -1,43 +1,64 @@ # Moneyforward APIリファレンス -[概要](README.md)はこちら +マネーフォワードAPIの概要については[こちら](README.md)を参照ください # Resources -## asset_classes -*現金、株式等の資産クラスマスタ* +## transactions - Resource | Description +*入出金履歴* + + Resource | Description :-----------|------------------------: - [GET /api/v1/asset_classes](asset_classes_index.md) | 資産クラスマスタの取得 + [GET /api/v1/transactions](transactions_index.md) | 入出金履歴の取得 + +## user_assets +*個別資産。現在保有する現金、株、FX、信用取引のポジション等* + + Resource | Description +:-----------|------------------------: + [GET /api/v1/user_assets](user_assets_index.md) | 個別資産リストの取得 + [GET /api/v1/user_assets/:id](user_assets_show.md) | 個別資産詳細の取得 -## asset_subclasses -*資産クラスをさらに細かく分類した資産サブクラスマスタ* +## user_asset_histories +*個別資産の履歴* - Resource | Description -:-----------|-----------------------: - [GET /api/v1/asset_subclasses](asset_subclasses_index.md) | 資産サブクラスマスタの取得 + Resource | Description +:-----------|------------------------: + [GET /api/v1/user_asset_histories](user_asset_histories_index.md) | 個別資産履歴リストの取得 + [GET /api/v1/user_asset_histories/:id](user_asset_histories_show.md) | 個別資産履歴詳細の取得 -## service_categories -*金融機関のカテゴリーマスタ* + +## user_asset_classes +*現金や株式等の資産クラス別の資産合計* Resource | Description -:-----------|-----------------------: - [GET /api/v1/service_categories](service_categories_index.md) | 金融機関のカテゴリーマスタの取得 +:-----------|------------------------: + [GET /api/v1/user_asset_classes](user_asset_classes_index.md) | 資産クラス別合計リストの取得 + -## aggregation_errors -*アグリゲーションのエラーマスタ* +## user_asset_class_histories +*資産クラス別の資産合計の履歴* Resource | Description -:-----------|-----------------------: - [GET /api/v1/aggregation_errors](aggregation_errors_index.md) | アグリゲーションのエラーマスタの取得 +:-----------|------------------------: + [GET /api/v1/user_asset_class_histories](user_asset_class_histories_index.md) | 資産クラス別合計履歴リストの取得 -## services -*銀行や証券会社、カード等、マネーフォワードで登録可能な金融機関のマスタ。* + +## user_asset_summaries +*保有資産について、同一asset_subclass、同一sub_account、同一currencyでグルーピングした個別資産の合計* + + Resource | Description +:-----------|------------------------: + [GET /api/v1/user_asset_summaries](user_asset_summaries_index.md) | 個別資産合計リストの取得 + [GET /api/v1/user_asset_summaries/:id](user_asset_summaries_show.md) | 個別資産合計詳細の取得 + +## user_asset_summary_histories +*個別資産合計の履歴* Resource | Description :-----------|------------------------: - [GET /api/v1/services](services_index.md) | 金融機関マスタの取得 - [GET /api/v1/services/:id](services_show.md) | 金融機関詳細の取得 + [GET /api/v1/user_asset_summary_histories](user_asset_summary_histories_index.md) | 個別資産合計履歴リストの取得 + [GET /api/v1/user_asset_summary_histories/:id](user_asset_summary_histories_show.md) | 個別資産合計履歴詳細の取得 ## accounts *登録金融機関。ユーザーが登録済みの金融機関情報* @@ -60,78 +81,63 @@ [POST /api/v1/additional_requests](additional_requests_create.md) | 追加の質問の作成 [PUT /api/v1/additional_requests/:id](additional_requests_update.md) | 追加の質問の更新 -## transactions -*入出金履歴* +## user +*ユーザー* - Resource | Description + Resource | Description :-----------|------------------------: - [GET /api/v1/transactions](transactions_index.md) | 入出金履歴の取得 + [GET /api/v1/user](user_show.md) | ユーザー情報の取得 + [DELETE /api/v1/user](user_destroy.md) | ユーザーの退会 -## user_assets -*個別資産。現金、株、FX、信用取引のポジション等* - Resource | Description -:-----------|------------------------: - [GET /api/v1/user_assets](user_assets_index.md) | 個別資産リストの取得 - [GET /api/v1/user_assets/:id](user_assets_show.md) | 個別資産詳細の取得 - -## user_asset_histories -*個別資産の履歴* +## asset_classes +*現金、株式等の資産クラスマスタ* - Resource | Description + Resource | Description :-----------|------------------------: - [GET /api/v1/user_asset_histories](user_asset_histories_index.md) | 個別資産履歴リストの取得 - [GET /api/v1/user_asset_histories/:id](user_asset_histories_show.md) | 個別資産履歴詳細の取得 - -## user_asset_summaries -*保有資産について、同一asset_subclass、同一sub_account、同一currencyでグルーピングした個別資産の合計* + [GET /api/v1/asset_classes](asset_classes_index.md) | 資産クラスマスタの取得 + +## asset_subclasses +*資産クラスをさらに細かく分類した資産サブクラスマスタ* - Resource | Description -:-----------|------------------------: - [GET /api/v1/user_asset_summaries](user_asset_summaries_index.md) | 個別資産合計リストの取得 - [GET /api/v1/user_asset_summaries/:id](user_asset_summaries_show.md) | 個別資産合計詳細の取得 + Resource | Description +:-----------|-----------------------: + [GET /api/v1/asset_subclasses](asset_subclasses_index.md) | 資産サブクラスマスタの取得 -## user_asset_summary_histories -*個別資産合計の履歴* +## service_categories +*金融機関のカテゴリーマスタ* Resource | Description -:-----------|------------------------: - [GET /api/v1/user_asset_summary_histories](user_asset_summary_histories_index.md) | 個別資産合計履歴リストの取得 - [GET /api/v1/user_asset_summary_histories/:id](user_asset_summary_histories_show.md) | 個別資産合計履歴詳細の取得 - -## user_asset_classes -*現金や株式等の資産クラス別の資産合計* +:-----------|-----------------------: + [GET /api/v1/service_categories](service_categories_index.md) | 金融機関のカテゴリーマスタの取得 - Resource | Description -:-----------|------------------------: - [GET /api/v1/user_asset_classes](user_asset_classes_index.md) | 資産クラス別合計リストの取得 - -## user_asset_class_histories -*資産クラス別の資産合計の履歴* +## aggregation_errors +*アグリゲーションのエラーマスタ* Resource | Description -:-----------|------------------------: - [GET /api/v1/user_asset_class_histories](user_asset_class_histories_index.md) | 資産クラス別合計履歴リストの取得 +:-----------|-----------------------: + [GET /api/v1/aggregation_errors](aggregation_errors_index.md) | アグリゲーションのエラーマスタの取得 -## user -*ユーザー* +## services +*銀行や証券会社、カード等、マネーフォワードで登録可能な金融機関のマスタ。* Resource | Description :-----------|------------------------: - [GET /api/v1/user](user_show.md) | ユーザー情報の取得 - [DELETE /api/v1/user](user_destroy.md) | ユーザーの退会 + [GET /api/v1/services](services_index.md) | 金融機関マスタの取得 + [GET /api/v1/services/:id](services_show.md) | 金融機関詳細の取得 + ## 認証 oAuth2: Authorization Code Flow -## アクセストークンの受け渡し方法 -Authorizationヘッダに以下の形式でaccess_tokenをセットする +## アクセストークンの連携方法 +Authorizationヘッダ、または X-MFOAuthToken ヘッダに以下の形式でaccess_tokenをセットする "Authorization: Bearer YOUR_ACCESS_TOKEN" ## データフォーマット -リクエスト、レスポンスともにJSON形式のみ +リクエスト、レスポンスともにJSON形式のみ。 ## ノーマルレスポンスのHTTPステータスコード