マネーフォワード クラウドのAPIを利用するには
このドキュメントでは、マネーフォワード クラウドのAPI（以下、本API）を利用するために必要な概念、および手順について開発者向けに説明します。
マネーフォワード クラウドのAPI連携の概要
API連携の仕組み
マネーフォワード クラウドのAPIを利用して外部システムとAPI連携するためには、まずマネーフォワード クラウドのデータリソースへのアクセス権限を示すアクセストークンの取得が必須です。
マネーフォワード クラウドのAPIは、セキュリティ確保のためOAuth 2.0の認可の仕組みを採用しています。アクセストークンは、ユーザーのIDやパスワードの代わりにアプリケーションがデータを取得・操作するために利用されます。
トークンと権限の概念
| 要素 | 役割 |
|---|---|
| アクセストークン | APIを呼び出す際に認証情報として使用される「一時的な利用許可証」。 |
| スコープ (Scope) | アクセストークンに付与される権限（どのサービスに対し、どのような操作が可能か）を定義する情報。APIを呼び出すには、そのAPIに対応した適切なスコープを持っている必要があります。 |
API利用に必要な前提条件
アクセストークンを取得するには、「アプリポータル」のご利用が必須となります。
「アプリポータル」とは マネーフォワード クラウドのAPIを利用して外部連携を開発する際に、必須となる設定を管理するためのポータルサイトです。 アプリポータルの登録および利用は無料です。
API利用の全体フロー
マネーフォワード クラウドのAPI連携は、次の3つの段階的なステップで進めます。
- STEP 1. アプリを登録する
- アクセストークン取得に必要なアプリ(Client)情報を登録します。
- STEP 2. アクセストークンを取得する
- 登録したアプリ情報を用いて、アクセストークンを取得します。
- STEP 3. マネーフォワード クラウドのAPIを呼び出す
- 取得したアクセストークンを使って、実際にマネーフォワード クラウドのAPIを呼び出します。
マネーフォワード クラウドのAPIの使用方法
STEP 1: アプリを登録する
アクセストークンを取得するためには、アプリ情報（Client ID/Client Secret）が必要です。そのために、事前にアプリポータルでアプリを登録し、そこからClient ID と Client Secret を取得します。
アプリポータルのご利用を開始されていない場合は、「アプリポータル」の利用開始方法に沿って利用開始してください。
アプリポータルにログイン後、アプリを登録します。登録完了後に Client ID および Client Secret が取得可能になります。詳細はチュートリアルの「STEP 1. アプリを登録する」を確認してください。
STEP 2: アクセストークンの取得
STEP1で登録したアプリ情報（Client IDとClient Secret、およびリダイレクトURI）を利用して、OAuth 2.0の認可フローを実行し、アクセストークンを取得します。詳細な手順はチュートリアルの「STEP 2. アクセストークンを取得する」を確認してください。
実際にAPI連携するには、連携プログラムを作成します。連携プログラムは次のようなフローでアクセストークンを取得します。
- 連携プログラムからユーザーを認証画面（認可エンドポイント）へリダイレクトします。
- このとき連携プログラムは必要なスコープを指定します。
- どのAPIを使用するかによって必要なスコープは異なります。使用したいAPIが要求するスコープをAPIリファレンスより確認してください。
- ユーザーに認証画面が表示され、ユーザーが連携を許可します。
- リダイレクトURIを通じて連携プログラムに「認可コード」が返されます。
- 連携プログラムは、この「認可コード」を使ってAPIアクセスに必要なアクセストークンを取得します。
具体的なプログラムの実装については、次のチュートリアルを参照してください。
STEP 3: APIリクエストの実行
STEP2で取得したアクセストークンを利用して、マネーフォワード クラウドのAPIを呼び出します。アクセストークンに付与されたスコープにAPIが要求するスコープが含まれている必要があります。具体的な手順はチュートリアルの「STEP 3. マネーフォワード クラウドのAPIを呼び出す」を確認してください。
APIのリクエスト方法やレスポンスについては、使用したいAPIのAPIリファレンスを参照してください。 なお、APIリファレンスを閲覧したい場合は各サービスのサポートよりお問い合わせください。