API を設定する

学習の目的

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

• 接続アプリケーションの設定方法を説明する。
  
• プロセステンプレートの設定方法を説明する。
  
• API の実行方法を説明する。
  

要件を定義する

登録を促進するために、Mary はサードパーティマーケティングプラットフォームを使用してメールマーケティングキャンペーンを実施したいと考えています。ただし、メール ID を提供済みのメンバーは 20% しかいません。そこで彼女は、メール ID を含めてプロファイルを更新したメンバーに 50 ポイントを付与することにします。このオプションは POS キットには直接含まれておらず、使用できる静的 API もありません。ただし、Eugene は設定可能 API を使用してこれを設定できます。重要なステップは次のとおりです。

1. 接続アプリケーションを設定する。
   
2. プロセステンプレートを設定する。
   
3. API をテストしてリリースする。
   

各ステップを詳しく見ていきましょう。

接続アプリケーションを設定する

サードパーティインテグレーションが機能するには、プラットフォーム間のデータをロイヤルティ管理と同期する必要があります。そのために Eugene が実行する手順は次のとおりです。

まず、外部システムと同期する必要があるロイヤルティ管理の項目とオブジェクトを特定します。次に、両方のシステムをロイヤルティ管理に接続するインテグレーションプラットフォームを設定します。

Eugene は外部システムとロイヤルティ管理を連携させるために接続アプリケーションを使用します。このアプリケーションは橋渡しの機能を果たし、外部システムが制御された安全な方法でロイヤルティ管理とやり取りを行い、データを交換できるようにします。両方のプラットフォームをリンクすると、外部プラットフォームはメンバーデータ取得などの特定の API にアクセスできるようになります。

Eugene は Cloud Kicks 組織内に接続アプリケーションを作成し、OAuth 設定を有効にします。これにより、認証のためのセキュリティキーを得られます。また彼は、外部のアプリケーションやサービスが Salesforce のデータと機能に対して持つアクセス権と権限を指定します。さらに、[Custom Settings (カスタム設定)] で認証情報を保存し、リモートサイトを設定します。

次に、Eugene が API によって実行されるメール更新プロセスを設定するところを見ていきましょう。

プロセステンプレートを設定する

メンバーが自分のメール ID を更新したときに、ロイヤルティプログラムでロイヤルティプログラムメンバーレコードと関連取引先責任者レコードの詳細を更新する必要があります。Eugene は [Update Member Details (メンバーの詳細を更新)] プロセステンプレートを使用してこれを設定します。

実際の業務では、通常はロイヤルティプログラムマネージャーまたはシステム管理者がロイヤルティプログラムプロセスを設定します。

このモジュールでは、受講者がロイヤルティプログラムマネージャーまたはシステム管理者で、ロイヤルティ管理でロイヤルティプログラムプロセスを設定する適切な権限を有していると想定しています。ただし、ロイヤルティプログラムマネージャーまたはロイヤルティ管理のシステム管理者でなくても問題ありません。このまま読み進み、本番組織でマネージャーがこれらの手順をどのように実行するのかを見てみましょう。Trailhead Playground で次の手順を実行しないでください。Trailhead Playground ではロイヤルティ管理を使用できません。

Eugene がメンバー詳細を更新するプロセスを設定する手順は次のとおりです。

1. をクリックして、[Loyalty Management (ロイヤルティ管理)] を選択します。
   
2. [All Loyalty Programs (すべてのロイヤルティプログラム)] リストビューが表示されることを確認します。
   
3. [Program Name (プログラム名)] 列で、[Cloud Kicks Inner Circle] ロイヤルティプログラムをクリックします。
   
4. [Loyalty Processes (ロイヤルティプロセス)] タブをクリックします。
   
5. [Loyalty Program Processes (ロイヤルティプログラムプロセス)] 関連リストで [New (新規)] をクリックします。
   
6. [Select a Process Template (プロセステンプレートを選択)] ウィンドウで [Create from Template (テンプレートから作成)] を選択し、[Next (次へ)] をクリックします。
   

7. [Update Member Details (メンバーの詳細を更新)] を選択して、[Next (次へ)] をクリックします。
   
8. [Loyalty Process Name (ロイヤルティプロセス名)] に UpdateMemberEmail と入力します。
   
9. [Save (保存)] をクリックします。ロイヤルティ管理によって自動的にプロセスとルールが作成されます。
   

10. [Update Member Details (メンバーの詳細を更新)] を開き、[Activate (有効化)] をクリックします。
    

11. [UpdateMemberEmail] ロイヤルティプロレスレコードで [Activate (有効化)] をクリックします。
    

これで有効なプロセスと有効なルールができました。次に、[Update Member Details (メンバーの詳細を更新)] API を使用してプロセスを e コマースサイトと統合します。これにより、外部サイトでメンバーが自分の詳細を変更したときにこのプロセスが実行されるようになります。

必要に応じて、システム間の通信とデータ交換を促進するためにミドルウェアレイヤーで API を有効にすることができます。大量のトランザクションが想定される場合はミドルウェアレイヤーを使用します。

Eugene は要件に合わせて API を設定しました。これにはエンドポイント、データ形式、要求と応答の構造、認証メカニズム、その他の詳細の指定が含まれます。また、API の仕様 (設定やエンドポイントなど) を文書化して、他の開発者が API の効果的な使用方法を理解できるようにしました。

API をリリースする前に、Eugene は API が想定どおりに動作するように広範なテストを実施します。

API をテストしてリリースする

ベストプラクティスとして、Eugene は API 開発ツールを使用して API のパフォーマンスと機能をテストします。

1. 任意の開発ツールを開きます。
   
2. ロイヤルティ管理組織のログイン情報を使用してログインします。
   
3. 環境と API バージョンを選択します。
   
4. [Utilities (ユーティリティ)]、[REST Explorer] に移動します。
   
5. [HTTP method (HTTP メソッド)] で [POST] を選択します。
   
6. [URL] に /services/data/v59.0/connect/loyalty/programs/Cloud+Kicks+Inner+Circle/program-processes/UpdateMemberEmail と入力します。
7. 次のペイロードを指定して実行します。
   

{
"processParameters": [
{
"CurrentMembershipNumber": "100009",
"MembershipNumber": "100009",
"EnrollmentDate": "2023-03-15",
"LastName":"Matthew",
"FirstName":"Abraham",
"Email":"abraham.matthew@nto.com"
}
]
}

API が実行され、メンバーレコードのメール ID が更新されます。

このモジュールでは REST Explorer を使用して API を照会しています。ただし、アプリケーションから API を直接トリガーすることもできます。

API が結果を正しく実行することを確認した後に、残りの API をテストします。最後に API を本番環境にリリースします。これで外部のクライアントやアプリケーションが API にアクセスできるようになります。

すべての API を設定した Eugene は、ユーザーエクスペリエンスチームと協力して、API をトリガーするエンドユーザー操作を設計します。

API がどのようにトリガーされるかを知る

API 実装の一環として、Eugene は API トリガーを設定します。これは、特定の API や一連の API コールの実行を開始するイベントや条件のことです。そのようなイベントの例をいくつか見てみましょう。

e コマースサイトでのメンバー登録

新しいユーザーが Cloud Kicks サイトにアクセスし、ロイヤルティプログラムに登録するウィジェットが表示されます。ユーザーは自分の情報を入力して [Join (参加)] ボタンをクリックします。登録プロセスが API をトリガーし、この API が新しいユーザーの個人取引先レコードとロイヤルティプログラムメンバーレコードを作成します。API はユーザーの詳細を受け取り、一意のメンバー ID を生成し、関連情報をロイヤルティ管理に保存します。

販売時点管理 (POS) システムとのインテグレーション

あるメンバーが店舗内で購入を行います。POS 画面のアクションボタンがロイヤルティ API をトリガーし、この API がトランザクションデータを同期します。これにより、ポイントがリアルタイムでメンバーのアカウントにクレジット処理され、シームレスなエクスペリエンスを提供できます。

同様のトリガーを他のサイトやシステムに設定して、さまざまな API をトリガーできます。

まとめ

ロイヤルティ管理 API を使用して、Eugene はロイヤルティプログラムを POS と e コマースシステムに統合することに成功しました。それ以来、Mary はカスタマーエンゲージメントが強化され、ユーザーエクスペリエンスが改善され、ロイヤルティプログラムの効果が向上したことを実感しています。日常的なプロセスを実行するために外部システムをロイヤルティ管理と統合するには、ビジネス API を使用します。指定されたオブジェクトの基本メタデータを取得したり、指定されたオブジェクトのレコードを作成したりするには SObject API を使用します。また、指定されたオブジェクトの基本メタデータを取得したり、指定されたオブジェクトのレコードを作成したりするには SObject API を使用します。

リソース

• 開発者ガイド: Create a Connected App for the OAuth 2.0 Client Credentials Flow (OAuth 2.0 クライアントログイン情報フロー用の接続アプリケーションの作成)
• Salesforce ヘルプ: 「メンバーの詳細を更新」プロセステンプレート