概要とビジネスシーン
Apex Callouts は、Salesforce が提供する強力な機能で、Salesforce プラットフォームから外部の Web サービス(REST API や SOAP Web サービスなど)に対して HTTP リクエストを送信し、データ交換を行うことを可能にします。これにより、Salesforce の機能を外部システムと連携させ、ビジネスプロセスを自動化し、データの統合を促進する中核的な価値を提供します。
実際のビジネスシーン
シーンA:eコマース業界 - 在庫管理と顧客体験の向上
- ビジネス課題:オンラインストアのリアルタイム在庫情報をSalesforceの商談や顧客サービスに連携できておらず、顧客への誤った在庫情報提供や販売機会の損失が発生。
- ソリューション:Apex Callouts を利用して、外部のERPシステムや在庫管理システムから商品在庫情報をリアルタイムで取得し、Salesforceの商談オブジェクトや商品オブジェクトに反映。顧客が問い合わせた際に正確な在庫情報を即座に提供できるようにする。
- 定量的効果:在庫情報の精度が99%に向上し、顧客満足度が15%改善、誤発注による返品率が10%減少。
シーンB:金融業界 - 与信審査の自動化とリスク管理
- ビジネス課題:住宅ローンや自動車ローンの与信審査において、外部の信用情報機関への手動でのデータ入力と照会が必要で、審査プロセスに時間がかかり顧客体験を損ねていた。
- ソリューション:Salesforce のローン申請オブジェクトから Apex Callouts を使用し、顧客情報を外部の与信情報サービスへセキュアに送信。返却された審査結果を Salesforce 上のカスタムオブジェクトに自動で格納し、審査プロセスを大幅に迅速化する。
- 定量的効果:与信審査プロセスが最大70%短縮され、顧客へのレスポンスタイムが改善。審査業務の効率化により、年間約2,000万円の人件費削減に貢献。
シーンC:製造業 - 物流追跡とサプライチェーンの可視化
- ビジネス課題:製造された製品の配送状況を顧客や社内担当者がリアルタイムで把握できず、問い合わせ対応に手間がかかっていた。
- ソリューション:Salesforce の注文オブジェクトから Apex Callouts を介して、外部の配送業者追跡APIに定期的にリクエストを送信。最新の配送ステータス(出荷済み、配送中、配達済みなど)を取得し、Salesforce 上に表示。顧客への自動通知も実装。
- 定量的効果:配送状況に関する顧客からの問い合わせが40%減少し、サプライチェーン全体の可視性が向上。物流コストの最適化に役立った。
技術原理とアーキテクチャ
Apex Callouts は、HTTP プロトコルに基づき、Salesforce 環境から外部 Web サービスへのリクエストとレスポンスを管理します。その基礎的な動作メカニズムは、HttpRequest オブジェクトでリクエストを構築し、Http クラスの send() メソッドで実行、そして HttpResponse オブジェクトでレスポンスを受け取るという流れです。
主要コンポーネントと依存関係
- HttpRequest(HTTPリクエスト):外部サービスに送信するリクエストのURL、HTTPメソッド(GET, POST, PUT, DELETEなど)、ヘッダー、ボディ(ペイロード)などを定義します。
- HttpResponse(HTTPレスポンス):外部サービスからの応答を受け取るためのオブジェクトです。ステータスコード、レスポンスヘッダー、レスポンスボディ(JSONやXML形式など)が含まれます。
- Httpクラス:
HttpRequestオブジェクトを送信し、HttpResponseオブジェクトを受け取るためのエントリポイントです。 - リモートサイト設定(Remote Site Settings):Salesforce のセキュリティ機能の一つで、Apex Callouts が通信を許可する外部エンドポイントの URL を事前に登録する必要があります。これにより、Salesforce は信頼できない外部サイトへの接続を防ぎます。
- 名前付き資格情報(Named Credential):認証情報を Salesforce 内部で安全に保管し、Apex コードから直接認証情報を扱うことなく、外部システムへのコールアウトを簡素化・セキュア化する機能です。リモートサイト設定を不要にし、より高度なセキュリティと管理を提供します。
データフロー
Apex Callouts の典型的なデータフローは以下のようになります。
| ステップ | 説明 | 主要コンポーネント |
|---|---|---|
| 1. リクエストの構築 | Apex コード内で外部サービスへ送信するリクエスト(URL, メソッド, ヘッダー, ボディ)を定義。 | HttpRequest |
| 2. リクエストの送信 | 構築したリクエストを外部サービスへ送信。 | Http.send() |
| 3. 外部システムでの処理 | 外部システムがリクエストを受け取り、内部で処理を実行。 | 外部 Web サービス |
| 4. レスポンスの生成 | 外部システムが処理結果を HTTP レスポンスとして生成。 | 外部 Web サービス |
| 5. レスポンスの受信 | Salesforce が外部システムからの HTTP レスポンスを受信。 | HttpResponse |
| 6. レスポンスの解析と処理 | 受信したレスポンスのステータスコードを確認し、レスポンスボディ(JSON/XML)を解析してSalesforceデータとして処理。 | Apex コード |
ソリューション比較と選定
Salesforce から外部システムと連携する方法は Apex Callouts 以外にもいくつか存在します。それぞれの特性を理解し、適切なソリューションを選択することが重要です。
| ソリューション | 適用シーン | パフォーマンス | Governor Limits | 複雑度 |
|---|---|---|---|---|
| Apex Callouts (同期) | リアルタイム性が高く、すぐに結果が必要な連携(例:与信審査、即時在庫確認)。 | 応答時間に依存。遅延するとUXに影響。 | 1トランザクションあたり最大10回、合計120秒のタイムアウト。 | 中:コードによる実装が必要。 |
| Apex Callouts (非同期 - @future) | リアルタイム性はそこまで求められず、時間のかかる処理(例:大量データの一括更新、長時間の外部APIコール)。 | バックグラウンドで実行されるため、UIへの影響は小さい。 | 1日あたり最大250,000回(または組織のユーザー数*200の大きい方)。120秒のタイムアウト。 | 中:コードによる実装が必要。 |
| External Services | 宣言的な方法で外部APIをSalesforceフローやLightning Web Componentから利用したい場合。コードを最小限に抑えたい場合。 | 実行はApex Calloutsに準拠。 | Apex Calloutsと同じGovernor Limits。 | 低〜中:設定が主で、コードは少なく済む場合が多い。 |
| Platform Events | イベントドリブン型アーキテクチャで、Publish-Subscribe パターンにより複数のシステムへの非同期通知や疎結合な連携を実現したい場合。 | リアルタイムに近い非同期。高いスケーラビリティ。 | Publish数、Subscribe数に制限あり。 | 中:イベント定義とイベントハンドリングの実装が必要。 |
- ✅ リアルタイムでのデータ取得/更新が必要な場合: ユーザーアクションに対して即座に外部データが必要なビジネスプロセス(例:注文時に在庫確認、顧客サービスでの履歴取得)。
- ✅ 特定のビジネスロジックに基づいて外部システムを呼び出す必要がある場合: Salesforce のレコードの作成/更新トリガーなど、複雑な条件に基づいて外部連携を実行したい。
- ✅ カスタム認証や複雑なリクエスト/レスポンス処理が必要な場合: 標準の統合機能では対応できない独自の認証メカニズムやデータ変換ロジックが求められる。
- ❌ 不適用シーン: 大量のデータを一括でバッチ処理したい場合(Platform EventsやBatch Apex with Calloutsを検討)。宣言的な設定のみで連携が完結する場合(External Servicesを検討)。
実装例
ここでは、外部の公開API(例: JSONPlaceholder)からデータを取得し、Salesforce 上で処理するシンプルな Apex Callout の例を示します。同期 Callout の基本的な実装と、非同期処理の利用方法を説明します。
同期 Callout の実装例 (GET リクエスト)
この例では、JSONPlaceholder から投稿データを取得します。
public class MyHttpCalloutService {
// 外部APIから投稿データを取得するメソッド
public static List<Post> getPosts() {
// 1. HttpRequest オブジェクトを初期化
HttpRequest request = new HttpRequest();
// Named Credential を使用する場合は、URL に 'callout:' スキーマを使用
// 例: request.setEndpoint('callout:MyNamedCredential/posts');
request.setEndpoint('https://jsonplaceholder.typicode.com/posts'); // ⚠️ リモートサイト設定にこのURLを登録する必要あり
request.setMethod('GET'); // HTTP GET メソッドを設定
request.setHeader('Content-Type', 'application/json'); // リクエストヘッダーを設定
Http http = new Http(); // Http クラスのインスタンスを作成
HttpResponse response = null; // レスポンスオブジェクトを初期化
try {
// 2. リクエストを送信し、レスポンスを受信
response = http.send(request);
// 3. レスポンスのステータスコードをチェック
if (response.getStatusCode() == 200) {
// レスポンスボディを文字列として取得
String responseBody = response.getBody();
// JSON レスポンスを解析して List<Post> オブジェクトにデシリアライズ
List<Post> posts = (List<Post>) JSON.deserialize(responseBody, List<Post>.class);
System.debug('取得した投稿数: ' + posts.size());
return posts;
} else {
// エラーレスポンスの場合
System.debug('Callout Error: ' + response.getStatusCode() + ' ' + response.getStatus());
System.debug('Response Body: ' + response.getBody());
throw new CalloutException('Failed to get posts: ' + response.getStatusCode() + ' ' + response.getStatus());
}
} catch (System.CalloutException e) {
// ネットワークエラーやタイムアウトなどの例外を捕捉
System.debug('Callout Exception: ' + e.getMessage());
throw new CalloutException('Callout failed: ' + e.getMessage());
}
}
// JSON レスポンスの構造に合わせた Apex クラス
public class Post {
public Integer userId;
public Integer id;
public String title;
public String body;
}
}
非同期 Callout の実装例 (@future メソッド)
Callout はガバナ制限が厳しいため、特に時間がかかる処理やユーザーインターフェースをブロックしたくない場合には、非同期 Apex(@future メソッドや Queueable Apex)を利用します。
public class MyAsyncHttpCalloutService {
// @future(callout=true) アノテーションにより、このメソッドが非同期で実行され、Callout が許可される
@future(callout=true)
public static void createPostAsync(String postTitle, String postBody, Integer userId) {
// 1. HttpRequest オブジェクトを初期化
HttpRequest request = new HttpRequest();
request.setEndpoint('https://jsonplaceholder.typicode.com/posts'); // ⚠️ リモートサイト設定にこのURLを登録する必要あり
request.setMethod('POST'); // HTTP POST メソッドを設定
request.setHeader('Content-Type', 'application/json;charset=UTF-8'); // ヘッダーでContent-Typeを指定
// リクエストボディを JSON 形式で作成
Map<String, Object> requestBodyMap = new Map<String, Object>();
requestBodyMap.put('title', postTitle);
requestBodyMap.put('body', postBody);
requestBodyMap.put('userId', userId);
String requestBody = JSON.serialize(requestBodyMap);
request.setBody(requestBody); // リクエストボディを設定
Http http = new Http(); // Http クラスのインスタンスを作成
HttpResponse response = null;
try {
// 2. リクエストを送信
response = http.send(request);
// 3. レスポンスのステータスコードをチェック (POST成功は通常 201 Created)
if (response.getStatusCode() == 201) {
System.debug('投稿が正常に作成されました: ' + response.getBody());
// 成功後の処理(例:Salesforce レコードの更新など)
} else {
System.debug('非同期 Callout エラー: ' + response.getStatusCode() + ' ' + response.getStatus());
System.debug('Response Body: ' + response.getBody());
// エラーログ記録や再試行ロジックの呼び出しなど
}
} catch (System.CalloutException e) {
System.debug('非同期 Callout 例外: ' + e.getMessage());
// 例外発生時の処理
}
}
}
実装ロジック解析
HttpRequestの設定:setEndpoint()で外部サービスのURL、setMethod()でHTTPメソッド(GET, POSTなど)、setHeader()でリクエストヘッダー(通常Content-Type: application/json)、setBody()でリクエストボディ(POST/PUTの場合)を設定します。Http.send()の実行:Httpクラスのインスタンスを作成し、send()メソッドに設定済みのHttpRequestオブジェクトを渡して実行します。この操作はネットワーク経由で外部サービスと通信します。HttpResponseの処理:send()メソッドはHttpResponseオブジェクトを返します。getStatusCode()でHTTPステータスコードを、getBody()でレスポンスボディを取得します。通常、JSON形式のボディはJSON.deserialize()を使用して Apex オブジェクトに変換します。- エラーハンドリング:
try-catchブロックを使用して、System.CalloutExceptionなどのネットワークエラーやタイムアウトを適切に処理します。 - 非同期処理 (
@future):@future(callout=true)アノテーションを使用することで、メソッドを新しいスレッドで非同期に実行し、Callout ガバナ制限とUIのブロックを回避できます。このアノテーションを付与することで、そのメソッド内での Callout が許可されます。
注意事項とベストプラクティス
権限要件
- リモートサイト設定(Remote Site Settings): Apex Callouts を実行する前に、Salesforce の「設定」→「リモートサイトの設定」で、Callout 先の外部システムの URL をすべて登録する必要があります。
- 名前付き資格情報(Named Credential): セキュリティと管理性を高めるため、可能な限り Named Credential を使用することを強く推奨します。これにより、リモートサイト設定が不要となり、認証情報がコードにハードコードされるリスクを防ぎます。
- プロファイル/権限セット: Named Credential を使用する場合、ユーザーに Named Credential へのアクセス権限をプロファイルまたは権限セットで付与する必要があります。
Governor Limits
Apex Callouts には、以下のような重要な Governor Limits が適用されます(2025年最新版として現在の情報に基づきます):
- 1トランザクションあたりの最大 Callouts 数: 10回
- 1トランザクションあたりの Callout タイムアウト: 同期 Callout は合計120秒(各 Callout は最大120秒)。非同期 Callout も同様に最大120秒。
- 非同期 Apex メソッドの1日あたりの実行制限: 250,000回、または組織の有料ユーザーライセンス数 * 200 (どちらか大きい方)。
@futureや Queueable Apex で Callout を実行する場合、この制限に含みます。 - HTTP リクエストボディの最大サイズ: 6 MB。
- HTTP レスポンスボディの最大サイズ: 6 MB。
エラー処理
try-catchブロック: Callout 処理はネットワークの不確実性が伴うため、必ずtry-catchブロックでSystem.CalloutExceptionを捕捉し、適切にエラーを処理してください。- HTTP ステータスコードの確認:
HttpResponse.getStatusCode()を使用して、成功 (例: 200 OK, 201 Created) または失敗 (例: 4xx クライアントエラー, 5xx サーバーエラー) を確認し、それに応じてロジックを分岐させます。 - 再試行メカニズム: 外部サービスの可用性やネットワークの一時的な問題に対応するため、指数バックオフ (Exponential Backoff) を用いた再試行ロジックを非同期 Callout で実装することを検討してください。
パフォーマンス最適化
- 非同期処理の活用: ユーザー体験を損なわないよう、時間のかかる Callout や複数の Callout を実行する場合は、
@futureや Queueable Apex を使用して非同期で実行します。 - Named Credential の利用: 認証情報の管理を簡素化し、オーバヘッドを減らします。また、Platform Cache を利用してトークンなどをキャッシュすることで、認証処理を高速化できます。
- レスポンスの最小化: 外部システムから取得するデータの量を最小限に抑えるよう、API設計者と連携し、必要なデータのみを返すように調整します。不要なデータはネットワーク転送時間やApexのメモリ使用量を増加させます。
- 接続の再利用: 同じエンドポイントへの複数の Callout が短い時間内に行われる場合、HTTP ヘッダーで Keep-Alive を設定することで、TCP コネクションの確立コストを削減できます。ただし、これは Salesforce のインフラレベルで管理されることも多いため、アプリケーションレベルで意識することは少ないかもしれません。
よくある質問 FAQ
Q1:Apex Callouts がタイムアウトする主な原因は何ですか?
A1:主な原因は、外部システムの応答遅延、ネットワークの不安定性、または Callout の実行時間が Salesforce の最大タイムアウト制限 (120秒) を超えることです。特に複雑な処理を外部システムが実行している場合や、外部システムが過負荷の状態にある場合に発生しやすいです。
Q2:Apex Callouts のデバッグにはどのようなツールや方法がありますか?
A2:Developer Console の「Debug Logs」が最も重要です。Callout ステップでのリクエスト/レスポンスの詳細、実行時間、ガバナ制限の使用状況を確認できます。また、外部システムのログを確認することも、問題の切り分けに役立ちます。HTTP ヘッダーの x-request-id などを利用して、Salesforce と外部システムのログを関連付けられるようにするとデバッグが容易になります。
Q3:非同期 Callouts のパフォーマンスを監視するにはどうすればよいですか?
A3:「設定」→「非同期 Apex ジョブ」で AsyncApexJob オブジェクトの状況を監視できます。また、カスタムオブジェクトに Callout の実行ログ(成功/失敗、実行時間、ペイロードなど)を記録し、レポートやダッシュボードで視覚化することも有効です。Salesforce のイベントモニタリング機能も、大規模な実装では役立ちます。
まとめと参考資料
Apex Callouts は、Salesforce を現代のコネクテッドビジネスの中心に据えるための不可欠な機能です。リアルタイム連携、ビジネスプロセスの自動化、データの統合といった幅広いユースケースに対応し、企業がSalesforceの価値を最大限に引き出すことを可能にします。
開発者は、セキュリティのベストプラクティス(Named Credentialの利用)、ガバナ制限の理解、堅牢なエラー処理、そして非同期処理の適切な活用を通じて、高性能で信頼性の高い統合ソリューションを構築することができます。
重要なポイント
- Apex Callouts は Salesforce と外部システム間の HTTP ベースのリアルタイム連携を可能にする。
- Named Credential はセキュリティと管理性を向上させるための最善の選択肢。
- Governor Limits、特にタイムアウトと Callout 数に常に注意を払う必要がある。
- エラー処理と再試行メカニズムは、堅牢な統合の基盤。
- 複雑または時間のかかる Callout は非同期 Apex (@future, Queueable) を利用して実装する。
公式リソース
- 📖 公式ドキュメント:HTTP Callouts
https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_callouts_http.htm - 📖 公式ドキュメント:Named Credentials and External Credentials
https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/apex_callouts_named_credentials.htm - 🎓 Trailhead モジュール:Apex Integration Basics
https://trailhead.salesforce.com/content/learn/modules/apex_integration_basics - 🎓 Trailhead モジュール:Use Asynchronous Apex
https://trailhead.salesforce.com/content/learn/modules/asynchronous_apex
コメント
コメントを投稿