はじめに(APIキー)
このドキュメントでは、APIキーによる認証を利用する前に確認すべき、対応サービスの範囲について説明します。
マネーフォワード クラウドのAPIを利用するための認証・認可には、APIキーによる認証とOAuth 2.0による認可の2つの方式があります。どちらの方式を利用できるかは、サービスごとに異なります。
APIキーで利用できるサービスとOAuth 2.0で利用できるサービスは一致しません。
(APIキーで利用可能であることとOAuth 2.0で利用可能であることは、それぞれ完全に独立した概念であり、互換性はありません)
APIキーで利用できるサービス
APIキーによる認証に対応しているサービスの条件は次のとおりです。
- アプリポータルの「APIキー新規登録」または「APIキー編集」の画面において、「利用可能サービス」の選択肢に表示されるサービス
上記以外のサービスでは、APIキーによる認証は利用できません。
注意
ご利用になりたいサービスが含まれない場合は、OAuth 2.0による認可の利用を検討してください。
OAuth 2.0で利用できるサービス
OAuth 2.0による認可に対応しているサービスの条件は次のとおりです。
- アプリポータルのユーザーの編集画面において、「アプリ連携権限」の選択肢に表示されるサービス
次のステップ
APIキーで利用できるサービスを確認したら、次のドキュメントに進んでください。
| 目的 | 次のステップ |
|---|---|
| アプリポータルにおけるAPIキーの役割と主な機能を知りたい | アプリポータルの概要(APIキー) |
| APIキー発行権限を安全に運用したい | アプリポータルの権限設計のベストプラクティス(APIキー) |
| APIキーの発行からJWTの取得・実装までを段階的に学びたい | チュートリアル: APIキーによる認証 |
/auth/exchangeエンドポイントの技術仕様を確認したい | APIリファレンス: /auth/exchange |
| OAuth 2.0による認可の概要やAPIキーとの違いを知りたい | OAuth 2.0による認可 |