マネーフォワード クラウド 認可サーバーAPI v2
こちらは、マネーフォワード クラウドの認可サーバー(以下、認可サーバー)が提供するAPI(以下、本API)のAPIリファレンスです。 このAPIリファレンスでは、本APIの使用方法の詳細について説明します。
本APIでできること
本APIは、マネーフォワード クラウドのAPIを使用するために必要なOAuth 2.0の認可コードフローをサポートしています。 これらを利用することで外部システムとの柔軟な連携を実現できます。
本APIでは、次のようなユースケースを実現します。
- 認可してアクセストークンを取得する
- アクセストークンをリフレッシュする
- 事業者情報を取得する
本APIを使用してアクセストークンを取得する詳しい使い方は、 「マネーフォワード クラウドのAPIを利用するには」を参照してください。
各APIの詳細は本APIリファレンスの各エンドポイントを確認してください。
共通仕様
認可エンドポイント、トークンエンドポイントについては、 RFC6749 The OAuth 2.0 Authorization Frameworkの仕様に準拠しています。
事業者情報の取得は、「マネーフォワード クラウドのAPI共通仕様」を参照してください。
お問い合わせ
本APIに関するお問い合わせはマネーフォワード クラウドのアプリポータル(以下、アプリポータル)使い方ガイドの 「お問い合わせ方法」をご利用ください。
アプリポータルに関しては、アプリポータルのサポートページをご利用ください。
更新・変更について
APIの更新・変更については、アプリポータルのサポートの 「新着情報・お知らせ」をご確認ください。
ベースURL
| API名 | URL |
|---|---|
| マネーフォワード クラウドの認可サーバー API | https://api.biz.moneyforward.com |
認証と認可について
- OAuth 2.0
- HTTP: Basic Auth
事業者情報を取得するAPIのみがこの対象です。 本APIの認証・認可はOAuth 2.0の認可コードフローを使用します。 詳細については「マネーフォワード クラウドのAPIを利用するには」をご覧ください。
OAuth エンドポイント
| エンドポイント | URL |
|---|---|
| 認可エンドポイント | https://api.biz.moneyforward.com/authorize |
| トークンエンドポイント | https://api.biz.moneyforward.com/token |
スコープ
本APIで使用するスコープは次のものです。エンドポイントのAPIリファレンスより必要なスコープを確認してください。
| スコープ | 説明 |
|---|---|
mfc/admin/tenant.read | 事業者情報の取得 |
クライアント認証方式が CLIENT_SECRET_BASIC の場合は、Basic認証を使用します。
ClientID:ClientSecretをBasic認証で指定してください。
詳しくは、マネーフォワード クラウドのアプリポータル使い方ガイドの 連携用アプリを登録するをご確認ください。
セキュリティ方式: | http |
|---|---|
HTTP Authorization Scheme: | basic |