外部サービスの登録

学習の目的

この単元を完了すると、次のことができるようになります。

  • 外部 Web サービスの指定ログイン情報を定義する。
  • 提供された API 仕様を使用して外部 Web サービスを追加する。
  • 外部サービスアクションが、API 仕様内のスキーマ定義とどのように関係しているのかを説明する。

最初にすべきこと: 指定ログイン情報とエンドポイントアクセス

外部サービスの使用を開始する前に、前提条件をいくつか完了する必要があります。前の単元では、API 仕様についてと、外部サービスでサポートされる有効なスキーマの構成要素について説明しました。有効でサポートされるスキーマに加えて、外部 Web サービスと Salesforce 組織を保護するシンプルな方法が必要です。それを実現するには、指定ログイン情報を使用して銀行サービスエンドポイントへのコールアウトを認証できます。 

一般的なプロジェクトでは、外部 Web サービスプロバイダが指定ログイン情報の要素を提供します。これらの要素には、コールアウトエンドポイントの URL と必要な認証パラメータが含まれます。前の単元で、API 仕様には REST ベースの API Web サービスのエンドポイント情報と認証パラメータが含まれると言いました。この情報を使用して、組織の指定ログイン情報を定義します。Trailhead Playground にアクセスして、次の手順を実行します。
  1. [設定] から、[クイック検索] ボックスに「指定ログイン情報」と入力し、[指定ログイン情報] を選択します。
  2. [新規指定ログイン情報] をクリックします。
  3. [表示ラベル] に「Bank」(銀行) と入力します。
  4. [名前] に「Bank」(英語) と入力します。
  5. [URL] に「https://th-external-services.herokuapp.com」と入力します。
  6. 他の項目はそのままにして、[保存] をクリックします。
認証と指定ログイン情報についての詳細は、この単元の最後にある「リソース」セクションを参照してください。実例では、さらに [指定ログイン情報] で認証プロトコルを設定し、認証プロバイダの定義も指定します (いずれも [設定] で実行します)。

外部サービスウィザードを使用した Web サービスの登録

有効な API 仕様があるため、この部分は簡単です。[外部サービス] で銀行の外部サービスを追加することで、Salesforce にやり取りの方法を指定します。  

  1. [設定] から、[クイック検索] ボックスに「外部サービス」と入力し、[外部サービス] を選択します。
  2. [新しい外部サービス] をクリックします。
  3. [外部サービス名] に「BankService」と入力します (スペースなし)。
  4. [指定ログイン情報を選択] で、[Bank (銀行)] (先ほど作成した指定ログイン情報) を選択します。
  5. [サービススキーマの相対 URL] を選択し、「/accounts/schema」と入力します。この文字列は、作成した指定ログイン情報に追加されます。これは API 仕様を指し示す相対 URL です。両者を合わせると、サービスプロバイダの完全な URL になります。例: https://th-external-services.herokuapp.com/accounts/schema
  6. [保存 & 次へ] をクリックします。
  7. すべての操作を選択します。
  8. [次へ] をクリックします。
  9. 外部サービスアクションのリストが表示されます。これで、これらのアクションを Flow Builder で使用できるようになりました。スクロールバーを使用すると、すべて表示できます。これで、API 仕様内の操作が Salesforce の呼び出し可能アクションになりました。
  10. [完了] をクリックします。
[外部サービスアクション] ページの例を次に示します。

アクションのリストは、メインの [外部サービス] ページで [BankService] をクリックすることでも表示されます。 

次の単元でシンプルなフローを作成し、フローパレットでアクションを見つける方法を説明します。ここでは、getAccount アクションとそのパラメータをいくつか見ていきましょう。

  • getAccount アクションは、口座情報を取得します。
  • accountName パラメータは、口座を指定します。
  • getAccount アクションには出力パラメータもいくつかあります。200 などのコードは、API 仕様で定義されている特定の応答コードに関連しています。これについては次の単元で説明しますが、Swagger エディタで API 仕様を検証するときにもこれらの定義は適切な形式で表示されます。
単元 1 で挙げた手順のうち、これで最初の 4 つのステップについて説明しました。
  1. 外部サービスプロバイダ (銀行など) が、REST ベースの API 仕様を共有する: この情報は、架空の銀行から受け取っています。
  2. OpenAPI 仕様に基づいて、Web サービスプロバイダまたは開発者 (場合によってはシステム管理者) が銀行の API を説明する JSON ベースのスキーマ定義を作成する: ここではこの API 仕様を実際に作成しませんでしたが、スキーマの要素とサポートされるスキーマの要件を確認しました。外部サービスと連携するときに、システム管理者またはその開発者が各自のユースケースに必要なスキーマを定義できます。
  3. Salesforce システム管理者が、外部サービスプロバイダから提供された URL を使用してサービスのエンドポイントを認証するための指定ログイン情報を宣言的に作成する: https://th-external-services.herokuapp.com という指定ログイン情報を定義しました。
  4. Salesforce システム管理者がサービスを宣言的に登録し、登録プロセス中に API 仕様と指定ログイン情報の両方を使用する: 1 つ目の外部サービスを登録して、アクションをウィザードで確認しました。

無料で学習を続けましょう!
続けるにはアカウントにサインアップしてください。
サインアップすると次のような機能が利用できるようになります。
  • 各自のキャリア目標に合わせてパーソナライズされたおすすめが表示される
  • ハンズオン Challenge やテストでスキルを練習できる
  • 進捗状況を追跡して上司と共有できる
  • メンターやキャリアチャンスと繋がることができる