APIキーによる認証 - チュートリアル
このチュートリアルについて
このチュートリアルでは、APIキーを使用してマネーフォワード クラウドのAPIにアクセスする方法を学習します。サーバー間通信や自動化スクリプトでAPIを利用する際に必要な、APIキーの発行からJWTの取得、実装のベストプラクティスまでを段階的に説明します。
学習内容
このチュートリアルを完了すると、以下のことができるようになります:
- アプリポータルでAPIキーを発行する
- APIキーを使用してJWTを取得する
- JWTを使用してマネーフォワード クラウドのAPIを呼び出す
- トークンのキャッシュと更新を適切に実装する
- セキュリティのベストプラクティスに従ってAPIキーを管理する
前提条件
このチュートリアルを開始する前に、以下の準備が必要です:
1. マネーフォワード IDアカウント
マネーフォワード クラウドのAPIを使用するには、マネーフォワード IDアカウントが必要です。まだアカウントをお持ちでない場合は、マネーフォワード IDで登録してください。
2. 開発環境
以下のいずれかの環境が必要です:
- コマンドラインツール: curlまたは類似のHTTPクライアント
- プログラミング環境: Node.js、Python、Ruby、Javaなど（お好みの言語）
このチュートリアルでは、curlコマンドとNode.jsを使用した例を示します。
APIキーとOAuth 2.0の違い
APIキーは、サーバー間通信や自動化スクリプトに適した認証方式です。ユーザーの操作を必要とせず、一度APIキーを発行すれば、バックエンドシステムから自動的にAPIを呼び出すことができます。
一方、OAuth 2.0認可フローは、ユーザー向けアプリケーション（Web、モバイル、デスクトップ）に適した認証方式です。ユーザーの同意を得て、ユーザーのデータにアクセスします。
どちらの方式を使用するかは、アプリケーションの種類や利用シーンによって異なります。詳細は、APIキーによる認証の概要を参照してください。
チュートリアルの構成
このチュートリアルは、以下の3つのステップで構成されています:
- STEP 1: APIキーを作成する - アプリポータルでAPIキーを発行します
- STEP 2: APIキーをJWTに交換する -
/auth/exchangeエンドポイントを使用してJWTを取得します - STEP 3: 実装のベストプラクティス - トークンのキャッシュ、更新、エラーハンドリングなどの実装パターンを学習します
所要時間
このチュートリアルは、約30分で完了できます。
次のステップ
準備ができたら、最初のステップに進みましょう: