デベロッパーセンター

外部APIへのConnect Sitecore CDP

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

このチュートリアルでは、Sitecore CDPを外部APIに接続する方法について説明します。この接続を作成したら、オーディエンスのエクスポートの出力をサードパーティのシステムに送信するために、オーディエンスのエクスポートに追加できます。

このチュートリアルでは、次の方法について説明します。

始める前に

Sitecore CDPで接続を作成する権限がある。
外部APIエンドポイントがJSONオブジェクトを返し、Content-Type: application/jsonレスポンスヘッダーが含まれていること、およびレスポンスステータスコードが200 OKであることを確認してください。

外部APIへのConnect Sitecore CDP

外部APIへの接続を作成するには:

ナビゲーションメニューで、「 Developer center > Connections > Create > External API」をクリックします。
Name & Describe画面で、次のフィールドに値を入力します。
- Name - 接続の一意で直感的な名前を入力します。
- Description - 接続の簡潔な説明を入力します。
「 Next 」をクリックして、Authenticateページに進みます。

接続を認証する

接続に名前を付けたら、外部APIへの接続を認証する必要があります。可能な場合は、OAuth 2を使用することをお勧めします。

接続を認証するには:

Authenticateページで、次のいずれかの認証方法をクリックし、必須フィールドに入力します。
- OAuth 2:
  - Access Token URL - 外部APIのアクセストークンのURLを入力します。アクセストークンは、外部APIによって生成されます。アクセストークンはHTTPS URLを使用する必要があります。これにより、安全な接続が使用されていることが保証されます。
  - Authentication option - 「 Header 」オプションを選択してヘッダーに認証資格情報を渡すか、「 Body 」オプションを選択して要求の本文に認証資格情報を渡します。
  - Client ID - 外部APIのクライアントIDを入力します。
  - Client Secret - 外部APIのクライアントシークレットを入力します。
  - Headers- 必要に応じて、Show headersをクリックし、最初のフィールドにキーを入力し、2番目のフィールドに値を入力します。追加のヘッダーを入力するには、「 Add Headers」をクリックします。Authentication optionでHeaderを選択した場合は、ここに認証パラメータと値を入力する必要があります。
  - URL encoded form - 必要に応じて、Show URL encoded formをクリックし、最初のフィールドにキーを入力し、2番目のフィールドに値を入力します。追加の項目を入力するには、Add form itemをクリックします。このオプションを使用すると、キーと値をSitecore CDPに送信できる有効なURL形式に変換できます。
  - Configure with Mutual TLS - をクリックして、相互トランスポート層セキュリティ(mTLS)を有効にします。これにより、Sitecore CDPと接続先の外部APIは、TLSプロトコルを使用して相互に認証できます。
    
    Sitecore CDPのmTLS JSON Web Key Set (JWKS) エンドポイントを表示するには、アイコンをクリックします。JWKSは、JSON Webトークン (JWT) の検証に使用される公開キーを含むキーのセットです。
- Basic:
  - Username - 外部APIへの資格情報を認証するためのユーザー名を入力します。
  - Password - 外部APIへの資格情報を認証するためのパスワードを入力します。
- None - これは公開APIにのみ使用され、外部APIへの接続には推奨されません。
「 Next 」をクリックして、Configure Requestページに進みます。

要求を構成する

リクエストを設定するときに、REST APIリクエストとレスポンスに関連付けられたメタデータを表すヘッダーとパラメータを設定できます。ヘッダーとパラメーターには、問題のトラブルシューティングに役立つ情報が含まれています。

リクエストを設定するには:

Configure RequestページのRequest URLドロップダウンリストで、要求で使用する次のHTTPメソッドのいずれかを選択します。
Request URLフィールドに、APIリクエストを送信するURLを入力します。

大事な

オーディエンスエクスポートの接続は、リクエストURLの {:placeholder-token:}${friendlyId}{/:placeholder-token:} などの変数をサポートしていません。
「Show Default Headers」をクリックすると、外部APIのデフォルトのヘッダーとパラメータが表示されます。
- Accept - このフィールドには、JSONが応答の受け入れられる形式であることを指定するapplication/jsonが表示されます。
- Accept-Encoding - このフィールドには、gzipが受け入れられる圧縮タイプであることを指定するgzipが表示されます。
- Content-Type - このフィールドには、リクエストで送信されるコンテンツの形式がJSONであることを指定するapplication/jsonが表示されます。
ヘッダーを追加するには、「 Add Header」をクリックします。次の項目を入力するための追加の行が表示されます。
- Key - ヘッダー名を入力します。
- Value - パラメータを入力します。
大事な

オーディエンスエクスポートの接続は、ヘッダーの {:placeholder-token:}${friendlyId}{/:placeholder-token:} などの変数をサポートしていません。
接続タイムアウトを設定するには、次のフィールドに入力します。
- Connection Timeout (ms) - ドロップダウンリストで、接続が閉じられるまでの非アクティブな時間(ミリ秒)を選択します。デフォルトは1000です。
- Read Timeout (ms) - ドロップダウンリストで、接続が確立されてからサーバーから応答を受信しなくなるまでのミリ秒数を選択し、その後接続が閉じます。デフォルトは1000です。
RequestフィールドでRequest attributes > Copy allをクリックし、コピーした内容をRequestフィールドに貼り付けます。

コピーされたコンテンツは、オーディエンスエクスポート通知属性のJSONオブジェクトです。この接続をオーディエンスのエクスポートに使用する予定の場合は、これらの属性を使用することをお勧めします。または、任意のペイロードを入力することもできます。

大事な

オーディエンスエクスポートの接続は、リクエストペイロードのカスタム変数をサポートしていません。標準属性の変数のみがサポートされています。
「 Test Request > Run Test」をクリックし、「 Next」をクリックします。

テストの結果は、関連するステータスコードとともにResponseフィールドに表示されます。
Map画面で、Nextをクリックします。
Review & Save画面では、接続の統合ビューを確認できます。接続が正しいことを確認してください。

危険

保存後は、接続を編集できません。保存する前に確認してください。
「 Next 」をクリックして、Review & Saveページに進みます。

接続が作成され、オーディエンスのエクスポートに追加できるようになります。

この記事を改善するための提案がある場合は、お知らせください!