SOAP API を使用する

他の SOAP ベース API の海峡を航行したことがあれば、Web Services Description Language (WSDL) ファイルとは基本的に、API の使用方法を理解するための地図であることをご存知でしょう。このファイルには、API コールを行うためのバインド、プロトコル、オブジェクトが含まれています。

Salesforce では、ユースケースに応じて選択できる 2 つの SOAP API WSDL を提供しています。Enterprise WSDL は、単一の Salesforce 組織向けに最適化されています。強く型付けされていて、組織に固有の設定を反映しています。つまり、2 つの異なる組織から生成された Enterprise WSDL ファイルには異なる情報が含まれています。

WSDL ファイルができたところで、次は SOAP API 要求を開始するために情報を抽出する方法が必要です。Web 業界用語では、このプロセスを WSDL の消費と呼びます。不運な船乗りたちを乗せた船をクラーケンが消化してしまうように、Web Services Connector (WSC) などのツールが WSDL ファイルを消費します。その後、ツールはクラスを作成し、それによってユーザーは一般的なプログラミング言語を使用して SOAP API による要求を行うことができます。

この単元では、SoapUI というサードパーティのツールを使用して、Enterprise WSDL ファイルを消費します。SoapUI は、Web サービスをテストするための無料でオープンソースのアプリケーションです。使用を開始するには、SoapUI の Web サイトから SoapUI OpenSource をダウンロードしてインストールします。SoapUI コンポーネントのみをインストールします。

SoapUI のインストールと起動が完了した後に、[File (ファイル)] メニューから [新規 SOAP プロジェクト] を選択します。プロジェクト名に「Exploring Salesforce SOAP API」 (Salesforce SOAP API の探索) と入力します。初期 WSDL に、Enterprise WSDL ファイルを保存した場所を参照してファイルを選択します。その他のオプションは変更しません。SoapUI ウィンドウは次のようになります。

[OK] をクリックします。数秒間の処理の後、画面左側のナビゲーターパネルに Exploring Salesforce SOAP API フォルダーが表示されます。その下に SoapBinding というエントリがあり、いくつかの操作が含まれています。

これらは何でしょう? 各操作は、実行できる SOAP API 要求に対応しています。各操作のプロパティは、WSDL ファイルの情報から取得されています。各操作には、サンプルの XML 要求も含まれ、その中には操作の HTTPS エンドポイントと事前入力された SOAP メッセージが含まれています。

最後にもう 1 つ、Salesforce ではすべての接続で TLS 1.2 以降を使用する必要があります。Java 7 で SoapUI を使用している場合、TLS 1.2 はデフォルトでは無効です。古いバージョンの TLS で Salesforce に接続しようとすると、エラーメッセージが表示されます。幸いにも、この問題は簡単に修正できます。詳細は、この便利なブログ投稿を参照してください。

これで、SOAP API 要求を行う準備が整いました。では先に進みましょう。

SoapUI で、login 操作までスクロールダウンします。展開し、[要求 1] をダブルクリックします。サンプルの SOAP ログイン要求が表示されます。

この例では管理パッケージを使用しません。そのため、URI の末尾からパッケージバージョンを削除できます。ここで、それを実行しましょう。

SOAP メッセージ (2) には、SOAP メッセージに本来含まれているエンベロープ、ヘッダー、ボディがすべて揃っています。

LoginScopeHeader 要素内のプロパティは、セルフサービスポータルおよびカスタマーポータルのユーザー認証に関するものです。ここでは、これらの値について考慮する必要がないため、<urn:LoginScopeHeader> 要素全体 (<urn: LoginScopeHeader> から </urn:LoginScopeHeader> までのすべて) を削除します。ウィンドウ内のテキストを強調表示して、Delete キーを押します。

次に、メッセージボディの <urn:login> 要素を見てみましょう。この要素は、ログイン要求の大部分です。ここでユーザーのログイン情報を指定します。? を Trailhead Playground のユーザー名とパスワードに置き換えます。

Salesforce が認識しない IP アドレスから API 要求を行っているため、パスワードの末尾にセキュリティトークンを追加する必要があります。たとえば、パスワードが mypassword で、セキュリティトークンが XXXXXXXXXX である場合、<urn:password> 要素内に「mypasswordXXXXXXXXXX」と入力します。

セキュリティトークンを取得するには、個人設定に移動し、[私の個人情報] の [私のセキュリティトークンのリセット] ページに移動します。[セキュリティトークンのリセット] をクリックして、トークンを使用する Trailhead Playground に関連付けられているメールアドレスにメールを送信します。

SOAP メッセージは次のようになります。

要求ウィンドウの左上にある再生ボタン (緑色の三角形) をクリックします。このボタンをクリックすると、要求が送信され、SOAP メッセージは瓶に入れられて海に流されます。応答を展開すると次のようになります。

おめでとうございます、船長。ログインに成功しました。応答には、組織とユーザーに関するさまざまな情報が含まれています。最も重要なのは、組織の [私のドメイン] の名前とセッション ID (次の図で強調表示されている部分) が含まれていることです。これらは今後の要求に使用します。

インスタンスとセッション ID をテキストファイルにコピーします。これらは、この後すぐに使用します。

組織のインスタンスは変更される可能性があるため、インテグレーションを構築するときにインスタンスに参照をハードコード化しないでください。代わりに、組織の [私のドメイン] のログイン URL を使用します。[私のドメイン] で、Salesforce 組織に顧客固有のドメインを設定します。[私のドメイン] はインスタンス名の変更に悩まされることがなく、独自のブランドを強調し、組織をより安全にし、ログインページをパーソナライズするためにも使用できます。