マネーフォワードクラウドのAPIを利用するには

このドキュメントでは、マネーフォワードクラウドのAPI（以下、本API）を利用するために必要な概念、および手順について開発者向けに説明します。

マネーフォワードクラウドのAPIの概要

本APIを利用する認証・認可は、OAuth 2.0による認可とAPIキーによる認証の2方式を用意しています。どちらを選ぶかはユースケースや、呼び出すエンドポイントがどちら（または両方）に対応しているかによって異なります。それぞれの概要は次のドキュメントを参照してください。

共通のリクエスト仕様は、API共通仕様を参照してください。

アプリポータルの概要（APIキー）：APIキー連携でのアプリポータルの役割、キー発行の流れ、関連コンポーネントを説明します。
アプリポータルの権限設計のベストプラクティス（APIキー）：APIキー発行権限や組織内での役割分担を安全に運用するためのベストプラクティスを説明します。
APIキーによる認証：APIキーの概念、/auth/exchange を使ったJWT取得、OAuthとの使い分けを説明します。

マネーフォワードクラウドのAPI共通仕様では、リクエスト・レスポンス形式、ページネーション、エラーなど、サービス横断の共通仕様をまとめています。

マネーフォワードクラウドのAPI変更ポリシーでは、公開APIの変更方針、バージョニング、破壊的変更と非破壊的変更の考え方を定めています。

チュートリアルでは、OAuthやAPIキーを用いたAPI連携を、手順に沿って試せるようにまとめています。

APIリファレンスでは、開発者サイトで一般に公開しているREST APIについて、OpenAPIに基づきエンドポイント、リクエスト、レスポンス、認証方式の対応状況を掲載しています。各項目を開き、呼び出すURLやパラメーターを確認してください。

マネーフォワードクラウドのAPIを利用して外部システムとAPI連携するためには、まずマネーフォワードクラウドのデータリソースへのアクセス権限を示すアクセストークンの取得が必須です。

マネーフォワードクラウドのAPIは、OAuth 2.0の認可フロー、またはAPIキーを用いた認証の仕組みを採用しています。アクセストークンは、ユーザーのIDやパスワードの代わりにアプリケーションがデータを取得・操作するために利用されます。

認証認可の仕組み	詳細
OAuth 2.0による認可	詳しくはOAuth 2.0による認可を参照してください。
APIキーによる認証	詳しくはAPIキーによる認証を参照してください。

アクセストークンを取得するには、「アプリポータル」のご利用が必須となります。

「アプリポータル」とはマネーフォワードクラウドのAPIを利用して外部連携を開発する際に、必須となる設定を管理するためのポータルサイトです。アプリポータルの登録および利用は無料です。詳しくは以下を参照してください。

マネーフォワードクラウドのAPIの利用は、次の3つの段階的なステップで進めます。

STEP 1. アプリを登録する
- アクセストークン取得に必要なアプリまたはユーザーの情報を登録します。
STEP 2. アクセストークンを取得する
- 登録したアプリ情報を用いて、アクセストークンを取得します。
STEP 3. マネーフォワードクラウドのAPIを呼び出す
- 取得したアクセストークンを使って、実際にマネーフォワードクラウドのAPIを呼び出します。