STEP 1. APIキーを作成する
このステップでは、アプリポータルでAPIキーを発行します。APIキーは、APIキーを発行したユーザーの権限でマネーフォワード クラウドのAPIにアクセスするための認証情報です。
APIキー発行の流れ
APIキーの発行は、以下の手順で行います:
- アプリポータルにログインする
- 対象のアプリを選択する
- APIキーセクションに移動する
- 新しいAPIキーを作成する
- アクセス対象のサービスを選択する
- APIキーを安全に保管する
手順
1. アプリポータルにログイン
アプリポータルにアクセスし、マネーフォワード IDでログインします。
2. 事業者を選択
ダッシュボードから、APIキーを発行したい事業者を選択します。
3. APIキーセクションに移動
左側のナビゲーションメニューから「APIキー」を選択します。
4. 新しいAPIキーを作成
「新規登録」ボタンをクリックします。
APIキー新規登録画面からAPIキーを登録します。
APIキーとは
発行したユーザーの権限でマネーフォワード クラウドのAPIを利用するための認証情報です。
複数事業者APIキーとは
1つのAPIキーで複数の事業者のAPIにアクセスするためのAPIキーです。詳細は複数事業者APIキーに関する補足を参照してください。
5. 利用可能サービスを選択
APIキーがアクセスできるサービスを選択します。
最小権限の原則に従い、必要なサービスのみを選択してください。不要なサービスへのアクセス権限は付与しないでください。
APIトークンのサポート状況について
各APIエンドポイントがサポートする認証方式（APIキー、OAuth、または両方）は異なります。使用予定のAPIエンドポイントがAPIキーをサポートしているか、APIリファレンスで確認してください。
6. APIキーを保存
「登録」ボタンをクリックすると、APIキーが生成されます。
重要: APIキーは一度だけ表示されます
生成されたAPIキーはこの画面でのみ表示され、後から再度確認できません。必ず安全な場所にコピーして保管してください。
APIキーを紛失した場合は、新しいAPIキーを発行する必要があります。
APIキーの形式
発行されたAPIキーは、以下の形式になります:
mf_api_prd_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
これは例です
上記のAPIキーは形式を示すためのダミーです。実際のAPIキーは、アプリポータルで発行したものを使用してください。
形式の詳細については、APIキーの形式を参照してください。
APIキーの安全な保管方法
APIキーは機密情報です。以下の方法で安全に保管してください:
環境変数として保存
開発環境では、環境変数を使用してAPIキーを管理します:
Linux/macOS (.bashrc または .zshrc):
export MF_API_KEY="mf_api_prd_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
Windows (PowerShell):
$env:MF_API_KEY="mf_api_prd_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"
.envファイル:
MF_API_KEY=mf_api_prd_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
.envファイルの取り扱い
.envファイルは.gitignoreに追加し、バージョン管理システムにコミットしないでください。
シークレット管理サービスを使用
本番環境では、以下のようなシークレット管理サービスの使用を推奨します:
- AWS Secrets Manager - AWSでアプリケーションを運用している場合
- Google Cloud Secret Manager - Google Cloudでアプリケーションを運用している場合
- Azure Key Vault - Azureでアプリケーションを運用している場合
- HashiCorp Vault - マルチクラウドやオンプレミス環境の場合
セキュリティのベストプラクティス
APIキーを安全に管理するため、以下の点に注意してください:
- コードに直接記述しない: ソースコードにAPIキーをハードコードしないでください
- バージョン管理システムにコミットしない:
.envファイルは.gitignoreに追加してください - 最小権限の原則に従う: 必要最小限のサービスのみを選択してください
- 定期的なローテーション: APIキーは定期的に新しいものに更新してください
- 漏洩時の対応: APIキーが漏洩した可能性がある場合は、直ちに無効化してください
詳細は、セキュリティ上の注意事項を参照してください。
APIキーIDについて
各APIキーには、固有のAPIキーIDが割り当てられています。APIキーIDは、アプリポータルで確認できる識別子です。
サポートへの問い合わせ時の注意
カスタマーサポートに問い合わせる際は、APIキー自体ではなく、APIキーIDを共有してください。
- ✅ 共有して良い: APIキーID（例:
key_abc123...） - ❌ 共有してはいけない: APIキー本体（例:
mf_api_prd_...）
APIキーIDを使用することで、サポートチームはAPIキー本体を知ることなく、お客様のAPIキーに関する問題を調査できます。
次のステップ
APIキーを発行し、安全に保管できたら、次のステップに進みましょう。
次は、発行したAPIキーを使用してJWTを取得する方法を学習します: