概要とビジネスシーン
Salesforce の名前付き資格情報(Named Credentials)は、外部システムとのセキュアな連携を簡素化し、認証情報の管理を一元化する強力な機能です。これにより、開発者は認証情報のハードコードや複雑な管理から解放され、より安全で保守性の高い統合ソリューションを構築できます。
実際のビジネスシーン
シーンA:製造業 - ERPシステム連携
- ビジネス課題:製造業の企業がSalesforceで受注管理を行い、在庫状況や出荷情報をリアルタイムでERPシステム(例:SAP, Oracle EBS)から取得する必要がありました。しかし、ERPシステムへの認証情報(APIキー、ユーザー名/パスワード)がApexコード内に散在し、セキュリティリスクと変更時のメンテナンスコストが高いという課題を抱えていました。
- ソリューション:Named Credentials を導入し、ERPシステムへの認証情報をSalesforce内で安全に管理しました。ApexコードからはNamed Credentialの名前を指定するだけでコールアウトが可能になり、認証情報がコードから分離されました。
- 定量的効果:認証情報管理にかかる運用コストを20%削減。セキュリティ監査の指摘事項を解消し、コンプライアンスを向上。ERPシステムへのAPI連携開発時間を15%短縮。
シーンB:金融サービス業 - 外部信用調査システム連携
- ビジネス課題:金融機関が顧客のローン申請処理において、外部の信用調査システム(例:Experian, Equifax)からリアルタイムで信用スコアを取得する必要がありました。この連携では厳格なセキュリティ要件と監査証跡が求められ、認証情報の漏洩リスクを最小限に抑えることが不可欠でした。
- ソリューション:Named Credentials を利用して、外部信用調査システムへのアクセス情報を一元管理。許可されたユーザーやプロファイルのみがNamed Credential経由でコールアウトを実行できるように権限を設定し、きめ細やかなアクセス制御を実現しました。
- 定量的効果:機密性の高い認証情報の漏洩リスクをほぼゼロに低減。新規連携開発のセキュリティレビュープロセスを30%効率化。規制要件への準拠を強化。
技術原理とアーキテクチャ
Named Credentials は、外部システムへの認証情報とURLエンドポイントをSalesforce内に安全に保存し、ApexコールアウトやフローからのHTTPリクエストを簡素化するメカニズムを提供します。主なコンポーネントは以下の通りです。
- 名前付き資格情報(Named Credential):外部システムへの呼び出しに使用するURLエンドポイントと認証設定(外部資格情報への参照)を定義します。Salesforce組織のリモートサイトの設定(Remote Site Settings)が不要になります。
- 外部資格情報(External Credential):認証プロトコル(OAuth 2.0、JWT、APIキー、基本認証など)と具体的な認証情報を定義します。この情報を複数のNamed Credentialで共有できます。
- プリンシパル(Principal):External Credential内の認証情報へのアクセスを許可するユーザーを定義し、パーミッションセットを介して割り当てます。
Named Credentials を使用するApexコールアウトの動作メカニズムは以下のデータフローで理解できます。
| ステップ | 説明 | 関連コンポーネント |
|---|---|---|
| 1. Apexでコールアウトをトリガー | ApexコードがHTTPリクエストをNamed Credentialのエンドポイントに送信します。 | HttpRequest, Apexクラス |
| 2. Named Credentialの解決 | Salesforceが指定されたNamed Credentialの名前から関連するURLと認証設定を特定します。 | Named Credentialレコード |
| 3. 認証情報の取得 | Named Credentialが参照するExternal Credentialから認証情報を取得します。ユーザーのPrincipalマッピングに基づいて認証情報を適用します。 | External Credential, Principal |
| 4. HTTPリクエストの実行 | Salesforceが認証情報を付加したHTTPリクエストを外部システムに送信します。通信はHTTPSで暗号化されます。 | Salesforceインフラ、外部システム |
| 5. レスポンスの受信 | 外部システムからのレスポンスをApexコードが受信し、処理します。 | HttpResponse, Apexクラス |
ソリューション比較と選定
外部システム連携において、Named Credentials はセキュリティ、保守性、開発効率の面で大きな利点を提供します。ここでは、主要な代替案と比較し、Named Credentials の適切な使用シーンを解説します。
| ソリューション | 適用シーン | パフォーマンス | Governor Limits | 複雑度 |
|---|---|---|---|---|
| Named Credentials | セキュアな認証情報管理が必要な外部システム連携(APIキー、OAuth、基本認証など)。コードから認証情報を分離したい場合。 | 中~高 (HTTPSオーバーヘッドは共通) | コールアウト制限 (100/トランザクション, 120秒) | 設定は比較的簡単。Apexコードは簡素化される。 |
| カスタム設定/カスタムメタデータで認証情報管理 | 認証情報が頻繁に変更されない、または機密性が比較的低い場合。シンプルなAPIキーなど。 | 中~高 | コールアウト制限 (100/トランザクション, 120秒) | 認証情報の暗号化が必要な場合、開発が複雑化。 |
| Apex HTTPCalloutで認証情報をハードコード | 非推奨。開発やテスト環境での一時的な利用のみ。 | 中~高 | コールアウト制限 (100/トランザクション, 120秒) | 実装は最も単純だが、セキュリティと保守性が最低レベル。 |
named credentials を使用すべき場合:
- ✅ 外部システムとの連携で認証情報(APIキー、OAuthトークン、ユーザー名/パスワードなど)を安全に管理する必要がある場合。
- ✅ Apexコードからリモートサイトの設定を排除し、コードと設定を分離したい場合。
- ✅ 複数の外部システムや環境(Sandbox、本番)で異なる認証情報やエンドポイントを簡単に切り替えたい場合。
- ✅ Salesforce組織のセキュリティポリシーとして、認証情報の暗号化と一元管理が義務付けられている場合。
- ✅ 認証情報を特定のユーザーやプロファイルに限定してアクセスを制御したい場合。
named credentials が不適用なシーン:
- ❌ Salesforceが外部システムに対して認証を必要としない公開APIエンドポイントのみを呼び出す場合(この場合でもNamed Credentialを使用するメリットはあります)。
- ❌ Salesforceのカスタムアダプターなど、Salesforceが提供するネイティブな統合機能を使用する場合。
実装例
Salesforce 開発者として、Named Credentials を使用したApexコールアウトは非常に一般的です。以下の例では、外部APIにGETリクエストを送信し、そのレスポンスを処理する方法を示します。この例では、My_External_Serviceという名前のNamed Credentialが事前に設定されていることを前提としています。
public class ExternalApiService {
/**
* @description 指定されたNamed Credentialを使用して外部APIからデータを取得します。
* @param namedCredentialName 使用するNamed Credentialのデベロッパー名 (例: 'My_External_Service')
* @param endpointPath APIエンドポイントのパス (例: '/users/1')
* @return HTTPレスポンスのボディ (String)
* @throws CalloutException コールアウトが失敗した場合
*/
public static String fetchDataFromExternalApi(String namedCredentialName, String endpointPath) {
// 1. HttpRequestオブジェクトをインスタンス化
HttpRequest request = new HttpRequest();
// 2. Named Credentialを指定してエンドポイントを設定
// これにより、URLと認証情報が自動的に処理されます。
request.setEndpoint('callout:' + namedCredentialName + endpointPath);
// 3. HTTPメソッドを設定 (今回はGETリクエスト)
request.setMethod('GET');
// 4. ヘッダーを追加 (オプション、APIの要件に応じて)
request.setHeader('Accept', 'application/json');
// 5. Httpオブジェクトをインスタンス化し、リクエストを送信
Http http = new Http();
HttpResponse response = http.send(request);
// 6. レスポンスのステータスコードをチェック
if (response.getStatusCode() == 200) {
// 成功した場合、レスポンスボディを返す
return response.getBody();
} else {
// 失敗した場合、エラーをスロー
throw new CalloutException(
'API Callout failed with status code: ' + response.getStatusCode() +
', status: ' + response.getStatus() +
', body: ' + response.getBody()
);
}
}
/**
* @description 外部APIにデータを送信します (POSTリクエストの例)。
* @param namedCredentialName 使用するNamed Credentialのデベロッパー名
* @param endpointPath APIエンドポイントのパス (例: '/users')
* @param requestBody 送信するデータ (JSON形式のString)
* @return HTTPレスポンスのボディ (String)
* @throws CalloutException コールアウトが失敗した場合
*/
public static String postDataToExternalApi(String namedCredentialName, String endpointPath, String requestBody) {
HttpRequest request = new HttpRequest();
request.setEndpoint('callout:' + namedCredentialName + endpointPath);
request.setMethod('POST');
request.setHeader('Content-Type', 'application/json');
request.setBody(requestBody); // POSTリクエストのボディを設定
Http http = new Http();
HttpResponse response = http.send(request);
if (response.getStatusCode() >= 200 && response.getStatusCode() < 300) { // 2xx系は成功
return response.getBody();
} else {
throw new CalloutException(
'API POST Callout failed with status code: ' + response.getStatusCode() +
', status: ' + response.getStatus() +
', body: ' + response.getBody()
);
}
}
}
このコードを匿名実行ウィンドウまたは別のApexクラスから呼び出すには、以下のようにします。
// サービスを呼び出し、レスポンスを処理
try {
String responseBody = ExternalApiService.fetchDataFromExternalApi('My_External_Service', '/some_resource');
System.debug('API Response: ' + responseBody);
// POSTリクエストの例
String jsonPayload = '{"name": "Test User", "email": "test@example.com"}';
String postResponseBody = ExternalApiService.postDataToExternalApi('My_External_Service', '/users', jsonPayload);
System.debug('POST API Response: ' + postResponseBody);
} catch (CalloutException e) {
System.debug('Callout Error: ' + e.getMessage());
}
この実装のポイントは、request.setEndpoint('callout:' + namedCredentialName + endpointPath); の行です。このcallout:プレフィックスを使用することで、Salesforceは指定されたNamed Credentialを自動的に参照し、関連するURLと認証情報を使用して外部システムに安全に接続します。開発者は認証情報の詳細をコードに記述する必要がありません。
注意事項とベストプラクティス
Named Credentials を利用する際には、以下の点に注意し、ベストプラクティスに従うことが重要です。
- 権限要件:
- Named Credentialを利用するユーザーは、関連する外部資格情報プリンシパル(External Credential Principal)が割り当てられたパーミッションセット(Permission Set)を持っている必要があります。これにより、どのユーザーがどの認証情報を使ってコールアウトできるかを細かく制御できます。
- 管理者(Named Credentialを作成・編集するユーザー)は「すべて設定(Customize Application)」の権限と「ユーザーの管理(Manage Users)」の権限が必要です。
- Governor Limits:
- 1トランザクションあたり最大100回のコールアウトが可能です。
- 1トランザクションあたりの累積コールアウト時間は120秒です。
- HTTPリクエストとレスポンスのボディサイズは最大6MBです。
- 1日あたりの非同期コールアウト(例: Futureメソッド、Queueable Apexからのコールアウト)の合計数は、組織あたり250,000回または組織内のユーザーライセンス数の200倍のいずれか大きい方です(2025年時点の一般的な制限)。
- エラー処理:
- 常に
try-catchブロックを使用してコールアウトエラーを適切に捕捉し、ユーザーフレンドリーなメッセージを表示するか、ログに記録してください。一般的なエラーには、ネットワーク接続の問題、外部APIからの不正なレスポンス(例: 4xx, 5xxステータスコード)、Governor Limitの超過などがあります。 - 特定のHTTPステータスコード(例: 401 Unauthorized, 403 Forbidden)に基づいて、認証情報の有効期限切れやアクセス権の問題を特定し、適切な通知メカニズムを実装することを推奨します。
- 常に
- パフォーマンス最適化:
- 非同期コールアウトの活用:長時間実行されるコールアウトや、複数の独立したコールアウトが必要な場合は、FutureメソッドやQueueable Apexを利用して非同期で実行し、ユーザーインターフェースの応答性を確保してください。
- 外部API側のパフォーマンス最適化:外部APIが迅速にレスポンスを返すように、外部システムのパフォーマンスチューニングも重要です。
- リクエストのバッチ処理とキャッシュ:可能な場合は、複数のリクエストをまとめて1回のコールアウトで処理するバッチAPIを利用したり、頻繁にアクセスされるが変化の少ないデータはSalesforce内でキャッシュしたりすることを検討してください。
よくある質問 FAQ
Q1:Named Credentials を設定すると、リモートサイトの設定は不要になりますか?
A1:はい、その通りです。Named Credentials を使用して外部システムにアクセスする場合、Salesforceは自動的にそのエンドポイントを信頼されたサイトとして扱います。手動でのリモートサイトの設定は不要になります。
Q2:Named Credentials を使用したコールアウトのデバッグ方法は?
A2:Developer Console のデバッグログ(Debug Logs)を活用します。ログレベルを適切に設定し、Callout、Apex Code、Systemなどのカテゴリを詳細に設定することで、リクエストやレスポンスのボディ、ヘッダー、およびエラーメッセージを確認できます。また、外部システムのログも確認することが重要です。
Q3:Named Credentials を利用しているコールアウトのパフォーマンスを監視するにはどうすればよいですか?
A3:Salesforce のイベントモニタリング(Event Monitoring)や、Developer Console の「Apex Jobs」および「Background Jobs」セクションで非同期ジョブの実行状況を確認できます。外部システムのAPIパフォーマンスメトリクスも同時に監視し、ボトルネックを特定してください。カスタムメトリクスやログをSalesforce内に構築してパフォーマンスデータを収集することも可能です。
まとめと参考資料
Named Credentials は、Salesforce と外部システム間のセキュアな統合を実現するために不可欠な機能です。認証情報管理の簡素化、セキュリティの強化、そして開発者の生産性向上に大きく貢献します。適切に利用することで、堅牢で保守性の高い統合ソリューションを構築できます。
重要ポイント:
- Named Credentials は認証情報をApexコードから分離し、セキュリティと保守性を向上させます。
- External Credentials と Principal を組み合わせることで、認証プロトコルとユーザーごとのアクセス制御を柔軟に設定できます。
callout:プレフィックスを使用することで、Apexコードは簡潔になり、リモートサイトの設定が不要になります。- Governor Limits、特にコールアウトの回数と実行時間には常に注意し、非同期処理を適切に活用してください。
- 適切なエラー処理とデバッグ戦略は、堅牢な統合の鍵となります。
公式リソース:
- 📖 公式ドキュメント:Named Credentials Limits
- 📖 公式ドキュメント:About Named Credentials
- 📖 公式ドキュメント:External Credentials
- 🎓 Trailhead モジュール:Integrate with Named Credentials
コメント
コメントを投稿