メインコンテンツまでスキップ

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

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

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

本APIは、外部のシステムやサービスからマネーフォワード クラウドのデータや機能にアクセスするためのREST APIです。

クライアントからのHTTPリクエストによってマネーフォワード クラウドの各サービスのデータの取得や操作ができます。

マネーフォワード クラウドの各サービスのAPIは順次提供されます。詳しくはサポートサイトおよび各サービスのAPIリファレンスを確認してください。

APIと各サービスの関係​

API（Application Programming Interface）は、異なるシステムやサービスの間でデータや機能をやりとりするためのインターフェイスです。本APIが公開するエンドポイントは、内部的にマネーフォワード クラウドの各サービスに対する処理を実行してデータの取得や操作をします。

レイヤー役割
クライアント外部（マネーフォワード クラウド以外）のシステムやサービスのこと。
HTTPリクエストでAPIのエンドポイントを呼び出す。
APIエンドポイントを公開・提供するインターフェイス。
クライアントからリクエストを受け付け、認証・認可、各サービスに対する処理の仲介を担う。
各サービス「クラウド会計」などマネーフォワード クラウドが提供するサービス。
APIが受け付けたリクエストに基づくデータの取得や操作の実体を担う。

利用規約​

本APIの利用にあたっては、以下の各利用規約に準拠するものとします。

認証・認可の方式​

本APIを利用して外部のシステムやサービスと連携するためには、まずマネーフォワード クラウドのデータや機能へのアクセス権限を示すアクセストークンの取得、つまり認証・認可が必須です。アクセストークンは、ユーザーのIDやパスワードの代わりにアプリケーションがデータを取得・操作するために利用されます。

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

OAuth 2.0の場合​

  1. アプリポータルの概要（OAuth）：OAuth 2.0による連携でのアプリポータルの役割、登場人物、運用上の注意を説明します。
  2. アプリポータルの権限設計のベストプラクティス（OAuth）：アプリポータル上の権限付与や連携承認を安全に運用するための標準を説明します。
  3. OAuth 2.0による認可：OAuth 2.0の概念、認可フロー、アクセストークン、スコープなどを説明します。

APIキーの場合​

  1. はじめに（APIキー）: APIキーを利用できるサービスの特徴や制約を説明します。
  2. アプリポータルの概要（APIキー）：APIキーによる連携でのアプリポータルの役割、キー発行の流れ、関連コンポーネントを説明します。
  3. アプリポータルの権限設計のベストプラクティス（APIキー）：APIキー発行権限や組織内での役割分担を安全に運用するための標準を説明します。
  4. APIキーによる認証：APIキーの概念、APIキー交換エンドポイントを使ったJWT取得、OAuth 2.0との使い分けを説明します。
  5. 複数事業者APIキーに関する補足：APIキーのうち複数事業者APIキーに固有の特徴や用途を説明します。

API共通仕様​

マネーフォワード クラウドのAPI共通仕様では、リクエストやレスポンスの形式、ページネーション、エラー、レート制限など、認証・認可の方式やサービスに依存しない共通仕様をまとめています。

認証・認可の方式に固有の仕様は次のドキュメントを、また各サービスに固有の仕様はAPIリファレンスを参照してください。

API変更ポリシー​

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

APIチュートリアル​

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

APIリファレンス​

APIリファレンスでは、OpenAPI仕様に基づき各エンドポイントのメソッド、URL、リクエストやレスポンスの仕様、認証・認可の方式などを掲載しています。各エンドポイントごとのページを開き、呼び出すURLやパラメーターを確認してください。

API利用に必要な前提条件​

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

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

ページ所在概要
マネーフォワード クラウド会計APIについてサポートサイトAPIを提供する各サービスのガイドの一例
マネーフォワード クラウドのアプリポータル 使い方ガイドサポートサイトアプリポータルを操作・利用するためのガイド
アプリポータルの概要（OAuth）APIドキュメントOAuthでAPIを利用する際のアプリポータルの役割や使い方
アプリポータルの概要（APIキー）APIドキュメントAPIキーでAPIを利用する際のアプリポータルの役割や使い方

API利用の全体フロー​

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

OAuth 2.0の場合​

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

詳しくはOAuthによる認可の仕組みを学ぶを確認してください。

APIキーの場合​

  1. STEP 1. APIキーを発行する
    • アクセストークン（JWT）取得に必要なAPIキーを発行します。
  2. STEP 2. アクセストークン（JWT）を取得する
    • 発行されたAPIキーと交換してアクセストークン（JWT）を取得します。
  3. STEP 3. マネーフォワード クラウドのAPIを呼び出す
    • 取得したアクセストークン（JWT）を使って、実際にマネーフォワード クラウドのAPIを呼び出します。

詳しくはAPIキーによる認証の仕組みを学ぶを確認してください。