【Salesforce】ApexでHTTPRequestを使用する

※本サイトにはプロモーション・広告が含まれています。

（最終更新月: 2024年2月）

✔以下の疑問をお持ちの方へ向けた記事です

「Salesforce ApexでHTTPRequestを使って外部サービスとどのように通信するのか？」
「HTTPRequestを使用する際の主なステップは何か？」
「HTTPRequestを用いたAPI呼び出しのベストプラクティスは？」

✔当記事を読むことで得られる知識

  • Salesforce ApexでHTTPRequestを使用する基本的なフロー
  • HTTPRequestの設定方法とパラメータの指定
  • HTTPRequestを使用したAPI呼び出しのセキュリティとエラーハンドリングのベストプラクティス

HTTPRequestを使うことで、SalesforceからHTTPリクエストを送信し、外部システムとのデータ交換やサービスの利用が可能です。

Salesforceの開発者が外部APIと効果的に連携するための実践的なガイドとなるでしょう。

ぜひ最後までご覧ください。

Salesforce

定義や属性などは公式ガイドを必ず参考にしましょう。

当記事では、主にその使い方を具体例とともに解説します。

筆者プロフィール

筆者プロフィールアイコン

【現職】プロダクトマネージャー

プロダクトマネージャーとして、Apex・Visualforceの開発エンジニアとして、以下のようなプロジェクトに従事してきました

  • 新規事業の立ち上げに伴うビジネスプロセス構築とSalesforceのカスタマイズ
  • SFDXを活用した大規模リリース
  • Visualforce等による一般ユーザー向けサイト・アプリケーションの構築

相談・業務の依頼も承ります。ご質問・ご希望をお問い合わせください。

HTTPリクエストの基本

こちらでは、HTTPリクエストの基本についてお伝えしていきます。

HTTPリクエストを理解することは、ウェブ開発やAPIとの連携をスムーズに行うために不可欠です。

  • HTTPリクエストとは何か
  • ApexでのHttpRequestオブジェクトの作成
  • リクエストメソッドとヘッダーの設定

HTTPリクエストとは何か

HTTPリクエストは、ウェブサーバーに対して何らかのデータやアクションを求めるための要求です。

これは、次のような構造をもったクライアント（通常はウェブブラウザやアプリケーション）からサーバーへ送信されるメッセージになります。

  • スタートライン
  • ヘッダ
  • ボディ

例えば、あなたがブラウザでウェブページを開く時、ブラウザはHTTPのGETメソッドを使用してサーバーにリクエストを送ります。

具体的なHTTPリクエストの例は次のとおりです。

GET /index.html HTTP/1.1
Host: www.example.com

この例では、GETメソッドを使用して、www.example.comのindex.htmlをリクエストしています。

ApexでのHttpRequestオブジェクトの作成

Apexにおいて、HTTPリクエストを作成するにはHttpRequestオブジェクトを利用します。

ApexはSalesforceのプログラミング言語で、HTTPリクエストを発行する際に用いるもの。

新しいリクエストを作成するには、以下のようなコードを使用します。

HttpRequest req = new HttpRequest();
req.setEndpoint('https://www.example.com');
req.setMethod('GET');

このコードはまずHttpRequestオブジェクトを新たにインスタンス化してから、リクエストするURL（エンドポイント）と、使用するHTTPメソッド（このケースではGET）を設定しています。

リクエストメソッドとヘッダーの設定

HTTPリクエストをカスタマイズするためには、まず、以下などから使用するメソッドを選択します。

  • GET
  • POST
  • PUT
  • DELETE

さらにヘッダを設定することでリクエストの内容を詳細に制御できます。

たとえば、サーバーにリクエストの種類を伝えるためのContent-Typeヘッダーなど、です。

Apexのコードでの例は以下のとおり。

req.setHeader('Content-Type', 'application/json');

このようにsetHeaderメソッドを使用して、リクエストにJSON形式のデータを含めることをサーバーに伝えています。

アプリケーションに適した正しいヘッダーを設定することは、リクエストが成功するうえで非常に重要です。

HTTPリクエストの送信とレスポンスの処理

こちらでは、HTTPリクエストを送信し、レスポンスを受け取るプロセスについて詳しく見ていきます。

こちらを通じて、HTTPリクエストとレスポンスの流れを体系的に学ぶことができるでしょう。

  • Httpクラスを使用したリクエストの送信
  • HttpResponseオブジェクトの解析
  • ステータスコードとエラーハンドリング

Httpクラスを使用したリクエストの送信

リクエストを送信するためには、ApexのHttpクラスのインスタンスが必要です。

リクエストオブジェクトを作成し、設定した後に、これをHttpクラスのsendメソッドを介して送信します。

例えば次のようになります。

Http http = new Http();
HttpResponse res = http.send(req);

先に設定したHttpRequestオブジェクト（reqという変数名で表されている）を、Httpオブジェクトのsendメソッドで使用して送信。

そのレスポンスをHttpResponseオブジェクトに格納しています。

HttpResponseオブジェクトの解析

レスポンスが返されると、その内容はHttpResponseオブジェクトに格納されます。

このオブジェクトからステータスコードやレスポンスボディなどの情報を抽出可能。

たとえば、次のようにコードを記述することでレスポンスボディを取り出せます。

String responseBody = res.getBody();

また、レスポンスのステータスコードを確認するには以下のように記述します。

Integer statusCode = res.getStatusCode();

これらの情報を利用して、リクエストが成功したか、あるいは何らかのエラーが発生したかを判断できます。

ステータスコードとエラーハンドリング

HTTPレスポンスには、処理結果を示すステータスコードが含まれています。

  • 200番台: 成功
  • 400番台: クライアントエラー
  • 500番台: サーバーのエラー

アプリケーションではこのコードを検証して、適切なエラーハンドリングを行なう必要があります。

if (statusCode >= 200 && statusCode < 300) {
    // 成功の処理
} else if (statusCode >= 400 && statusCode < 500) {
    // クライアントエラーの処理
} else if (statusCode >= 500 && statusCode < 600) {
    // サーバーエラーの処理
}

このような範囲チェックにより、異なる種類の結果に基づいた処理が可能です。

実践的なHTTPリクエストの使用例

こちらでは、実際にHTTPリクエストを使用する具体的な例を紹介します。

これを通じて、HTTPリクエストがいかに多用途であるかを理解し、自己のプロジェクトに応用できるようになるでしょう。

  • 外部APIへのデータ送信
  • REST APIからのデータ取得
  • 名前付き資格情報を使用したセキュアなAPI呼び出し

外部APIへのデータ送信

データを外部APIに送信するためには、HTTPリクエストのボディにデータを含めてPOSTメソッドを使います。

たとえば、JSON形式でデータを送信するコード以下のとおりです。

HttpRequest req = new HttpRequest();
req.setEndpoint('https://api.example.com/data');
req.setMethod('POST');
req.setHeader('Content-Type', 'application/json');

// データをJSON形式で設定する
String jsonData = '{""name"":""John Doe"",""email"":""johndoe@example.com""}';
req.setBody(jsonData);

Http http = new Http();
HttpResponse res = http.send(req);

このようにHttpRequestオブジェクトのsetBodyメソッドを使用してデータを設定し、sendメソッドでリクエストを送信します。

REST APIからのデータ取得

REST APIからデータを取得する際には、通常GETメソッドを用います。

リクエストのエンドポイントをセットし、必要に応じて認証情報をヘッダーに追加。

以下はその例です。

HttpRequest req = new HttpRequest();
req.setEndpoint('https://api.example.com/users');
req.setMethod('GET');

Http http = new Http();
HttpResponse res = http.send(req);

String responseBody = res.getBody();
// レスポンスから受け取ったデータを処理する

この方法でAPIからデータを取得し、レスポンスボディから必要な情報を抽出できます。

名前付き資格情報を使用したセキュアなAPI呼び出し

Salesforceでは名前付き資格情報（Named Credentials）という機能を使って安全に外部システムへのアクセスも可能です。

この機能を利用すると、資格情報をセールスフォースの外に露出することなく、APIレクエストを認証できます。

こちらが例です。

HttpRequest req = new HttpRequest();
req.setEndpoint('callout:My_Named_Credential/path/to/data');
req.setMethod('GET');

Http http = new Http();
HttpResponse res = http.send(req);

// レスポンスを処理

My_Named_Credentialに事前に設定された認証情報を使用してリクエストを送信しています。

セキュリティを確保しつつ外部サービスとのコミュニケーションが可能です。

HTTPリクエストのベストプラクティスとパフォーマンス

こちらでは、ベストプラクティスとパフォーマンスの向上に焦点を当て、実効性のあるアドバイスを提供します。

HTTPリクエストを使用する際には、効率とセキュリティを考慮することが重要です。

  • ガバナ制限とパフォーマンス考慮事項
  • リクエストのバッチ処理と非同期処理
  • セキュリティベストプラクティス

ガバナ制限とパフォーマンス考慮事項

ApexのHTTPリクエストでは、ガバナ制限を気にする必要があります。

Apexではガバナ制限（Governor Limits）という上限が設定されているからです。

Salesforceのガバナ制限とは？主な内容とその対策
Salesforceのガバナ制限について詳しく知りたいですか？当記事では、SalesforceのApexやVisualforceにおけるガバナ制限の概要と、これらの制限にどう対応するかを詳細に解説します。効率的で安定したSalesforceアプリケーションを開発するために不可欠な情報が満載です。初心者から上級者まで、Salesforce開発の品質と効率を向上させたい方にとって必読の内容です。
itc.tokyo
2023.12.20

たとえば、特定期間内に発行できるHTTPリクエストの数などが制限されます。

これらの制限を意識し、複数のデータを一度に取得するようにリクエストを設計することが重要です。

また、実行時間を短縮するために、HTTPリクエストの応答が得られる前にほかのプロセスを続行できるような設計を考えることも有効です。

リクエストのバッチ処理と非同期処理

バッチ処理により、一度に多くのデータ処理が可能です。

ただし、サービスプロバイダーのAPIレート制限に注意する必要があります。

非同期処理により、HTTPリクエストをバックグラウンドで実行し、他プロセスのブロッキングを防げるのもメリットです。

Salesforceでは@futureアノテーションやQueueableインターフェースを利用して非同期処理をおこなえます。

セキュリティベストプラクティス

セキュリティはHTTPリクエストを扱ううえで最重要事項のひとつです。

エンドポイントのURLがHTTPSであることを保証し、センシティブなデータは暗号化して通信することが重要。

また、名前付き資格情報の使用やOAuth 2.0などの安全な認証プロトコルの使用も検討すべきです。

トラブルシューティングとよくある質問

HTTPリクエストを使用する際に遭遇する可能性のある問題について議論し、これらの課題を克服するためのヒントを提供します。

トラブルシューティングをおこないながら、よくある質問に答えていきましょう。

  • よくあるエラーとその解決策
  • デバッグとロギングのヒント
  • コミュニティとドキュメントの活用

よくあるエラーとその解決策

HTTPリクエストの際によく遭遇するエラーは、タイムアウト、認証失敗、またはリクエスト形式の不一致などです。

それぞれ以下のような対処法が一般的になります。

  • タイムアウト問題: サーバー側のパフォーマンスの向上、またはリクエストタイムアウト時間を調整
  • 認証失敗: 認証情報の正しさを再確認または更新
  • リクエスト形式の問題は: ヘッダーの不正な値やリクエストボディの不正なフォーマットを検証

デバッグとロギングのヒント

問題の診断と解決には、デバッグとロギングが非常に役立ちます。

SalesforceではSystem.debug()を使用して、実行時の情報をログに出力。

これにより、リクエストやレスポンスに関する詳細情報を取得し、問題解析に役立てられます。

また、適切なログレベルを設定することで、必要な情報だけを取り出すことが重要です。

コミュニティとドキュメントの活用

Salesforceのコミュニティは活発であり、多くのデベロッパーが知識を共有しています。

公式のドキュメンテーション、開発者向けフォーラム、Stack Exchangeなどのリソースを活用して、問題解決のヒントを得られるでしょう。

また、Salesforceのドキュメントは非常に詳細であり、APIの利用方法やベストプラクティスについてのガイドを提供しています。

まとめ

当記事を通じて以下をお伝えしてきました。

  • HTTPリクエストの基本から実践的な使用例
  • パフォーマンスの最適化
  • セキュリティの確保

初心者の方も、この情報を参考にして、HTTPリクエストを扱う際の基礎を固められるはず。

今回学んだ知識を活かして、実際の開発プロジェクトでぜひ実践してみてください。

各ステップを踏まえながら、より堅牢で、責任を持って構築されたアプリケーションの構築を目指しましょう。

タイトルとURLをコピーしました