外部Connect Sitecore CDPに切り替えるAPI
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
このウォークスルーでは、Sitecore CDPを外部APIに接続する方法を説明しています。この接続を作成した後、オー ディエンスエクスポート に追加して 、その出力をサードパーティシステムに送信できます。
このウォークスルーでは、以下の方法を説明します:
!注始める前に
Sitecore CDPで接続を作成する権限を持っています。
外部APIエンドポイントがJSONオブジェクトを返し、Content-Type: application/json応答ヘッダーを含み、応答ステータスコードが200 OKであることを確認してください。
外部Connect Sitecore CDPに切り替えるAPI
外部APIへの接続を作成するには:
- ナビゲーションメニューで、Developer center > Connections > External API >作成してください。
- 「名前&説明」画面で、以下のフィールドに記入してください:
- 名前 - 接続に一意で直感的な名前を入力してください。
- 説明 - 接続の簡潔な説明を入力してください。
- 「 次へ 」をクリックすると 認証 ページに移動します。
接続の認証
接続に名前を付けた後は、外部APIへの接続認証が必要です。可能な限りOAuth 2の使用をお勧めします。
接続の認証方法:
- 認証ページで、以下のいずれかの認証方法をクリックし、必要な項目に記入してください:
-
OAuth 2:
-
アクセストークンURL - 外部APIのアクセストークンのURLを入力します。アクセストークンは外部APIによって生成されます。アクセストークンはHTTPS URLを使用する必要があります。これにより安全な接続を使用していることが保証されます。
-
Authentication option- 認証認証情報をヘッダー内のものに渡すにはヘッダーオプションを選択し、リクエストの本文に認証情報を渡すにはBodyオプションを選択する。
-
Client ID - 外部APIのクライアントIDを入力します。
-
Client Secret - 外部APIのクライアントシークレットを入力する。
-
Headers- オプションで「ヘッダーを表示」をクリックし、最初のフィールドにキー、2番目のフィールドに値を入力してください。追加のヘッダーを入力するには、「ヘッダーを追加」をクリックしてください。認証オプションでヘッダーを選択した場合、ここに認証パラメータと値を入力する必要があります。
-
URLエンコードフォーム - オプションで「 URLエンコードフォームを表示 」をクリックし、最初のフィールドにキー、2番目のフィールドに値を入力してください。追加項目を入力するには、「 フォームアイテムを追加」をクリックしてください。このオプションでは、キーや値を有効なURL形式に変換し、Sitecore CDPに送信できます。
-
Mutual TLSで設定 - Mutual Transport Layer Security(mTLS)を有効にするためにクリックしてください。これにより、Sitecore CDPと接続先の外部APIがTLSプロトコルを使って互いに認証できます。
Sitecore CDPのmTLS JSON Web Key Set(JWKS)エンドポイントを見るには、
アイコンをクリックしてください。JWKSは、あらゆるJSON Web Tokens(JWT)を検証するために使われる公開鍵を含む鍵の集合です。
-
-
基本:
- ユーザー名 - 外部APIの認証用ユーザー名を入力してください。
- パスワード - 外部APIの認証用パスワードを入力してください。
-
None - これは公開APIにのみ使用され、外部APIへの接続は推奨されません。
-
- 「次へ」をクリックすると「リクエストの設定」ページに移動します。
リクエストの設定
リクエストを設定する際に、REST APIリクエストとレスポンスに関連するメタデータを表すヘッダーやパラメータを設定できます。ヘッダーやパラメータには、トラブルシューティングに役立つ情報が含まれています。
リクエストを設定するには:
-
リクエスト の設定 ページのリクエストURLドロップダウンリスト で、リクエストで使用する以下のHTTPメソッドのいずれかを選択してください。
-
リクエストURL欄で、APIリクエストを送信するためのURLを入力します。
!重要オーディエンスエクスポート用の接続はリクエストURL内の ${friendlyId} などの変数をサポートしていません。
-
外部APIのデフォルトヘッダーとパラメータを表示するには「デフォルトヘッダーを表示」をクリックしてください:
- Accept - このフィールドはapplication/jsonを表示し、JSONが応答の受け入れフォーマットであることを示します。
- Accept-Encoding - このフィールドはgzipを表示し、gzipが受け入れられる圧縮タイプであることを示します。
- Content-Type - このフィールドはapplication/jsonを表示し、リクエストで送られるコンテンツのフォーマットをJSONに指定します。
-
追加のヘッダーを追加するには、「 ヘッダーを追加」をクリックしてください。次の項目を入力するための追加の行が表示されます:
-
キー - ヘッダー名を入力してください。
-
値 - パラメータを入力します。
!重要オーディエンスエクスポート用の接続はヘッダー内の ${friendlyId} などの変数をサポートしていません。
-
-
接続タイムアウトを設定するには、以下の項目を入力してください:
- 接続タイムアウト(ms) - ドロップダウンリストで、接続が終了するまでの非アクティブ期間のミリ秒数を選択します。デフォルトは1000です。
- 「タイムアウト(ms)」を読みます - ドロップダウンリストで、接続が確立されてからサーバーからの応答を受け取れないまでのミリ秒数を選択し、その後接続が終了します。デフォルトは1000です。」
-
リクエストフィールドで**「リクエスト属性**」>「すべてコピー」をクリックし、コピーしたコンテンツをリクエストフィールドに貼り付けます。
コピーされたコンテンツは、オーディエンスエクスポート通知属性のJSONオブジェクトです。この接続をオーディエンスエクスポートに使う予定がある場合は、これらの属性を使用することをおすすめします。または、お好きなペイロードを入力することもできます。
!重要オーディエンスエクスポートの接続はリクエストペイロード内のカスタム変数をサポートしていません。標準 属性 の変数のみがサポートされています。
-
「 テストリクエスト」 > 「テスト実行」をクリックし、次に クリックします。
テスト結果は対応フィールドに表示され、関連するステータスコードが表示されます。
-
地図画面で「次へ」をクリックします。
-
「レビュー &保存画面で、接続の統合ビューが表示されます。接続が正しいか確認してください。
!警告危険セーブ後は接続を編集できません。保存する前に必ず確認してください。
-
「次へ」をクリックすると「レビュー &保存」ページに移動します。
接続が作成され、オー ディエンスエクスポートに追加できます。