[ベータ版]{class="badge informative"}

Flow Service API を使用した PathFactory ベース接続の作成

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このドキュメントでは、[Flow Service API] (https://www.adobe.io/experience-platform-apis/references/flow-service/) を使用して PathFactory のベース接続を作成する方法について説明します。

基本を学ぶ

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

  • ソース:Experience Platform を使用すると、データを様々なソースから取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
  • サンドボックス:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

Platform API の使用

Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。

次の節では、Flow Service API を使用してに正常に接続するために必要な追加情報を示し PathFactory す。

必要な資格情報の収集 gather-credentials

Platform で PathFactory アカウントにアクセスするには、次の値を指定する必要があります。

資格情報
説明
ユーザー名
PathFactory アカウントのユーザー名。 これは、システム内のアカウントを識別するために不可欠です。
パスワード
PathFactory アカウントに関連付けられたパスワード。 権限のないアクセスを防ぐために、これが安全に保たれていることを確認します。
ドメイン
PathFactory アカウントに関連付けられたドメイン。 これは通常、PathFactory URL 内の一意の ID を参照します。
アクセストークン
システムと PathFactory ーザー間の安全な通信を確保するために、API 認証に使用される一意のトークン。
API エンドポイント

データにアクセスするための特定の API エンドポイント:訪問者、セッションおよびページビュー。 各エンドポイントは、取得可能な様々なデータセットに対応します。 メモ: これらは PathFactory で事前定義され、アクセスする予定のデータに固有です。

  • 訪問者エンドポイント:/api/public/v3/data_lake_apis/visitors.json
  • セッション エンドポイント: /api/public/v3/data_lake_apis/sessions.json
  • ページビューエンドポイント: /api/public/v3/data_lake_apis/page_views.json

資格情報の保護および使用方法、アクセストークンの取得および更新方法について詳しくは、PathFactory サポートセンターを参照してください。 このリソースでは、資格情報の管理と、効果的で安全な API 統合の確保に関する包括的なガイドを提供します。

ベース接続の作成

ベース接続は、ソースと Platform 間の情報(ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など)を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

ベース接続 ID を作成するには、/connections エンドポイントに対してPOSTリクエストを実行し、その際にリクエスト本文の一部として PathFactory 認証資格情報を指定します。

API 形式

POST /connections

リクエスト

次のリクエストは、PathFactory のベース接続を作成します。

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "PathFactory base connection",
      "description": "PathFactory base connection",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "acme-ab12c3d4e5fg6hijk7lmnop8qrst"
              "clientId": "pathfactory",
              "clientSecret": "xxxx"
          }
      },
      "connectionSpec": {
          "id": "ea1c2a08-b722-11eb-8529-0242ac130003",
          "version": "1.0"
      }
  }'
プロパティ
説明
auth.params.clientId
PathFactory アプリケーションに関連付けられたクライアント ID。
auth.params.clientSecret
PathFactory アプリケーションに関連付けられたクライアント秘密鍵。
connectionSpec.id
PathFactory 接続仕様 ID: ea1c2a08-b722-11eb-8529-0242ac130003

応答

応答が成功すると、一意の接続識別子(id)を含む、新しく作成された接続が返されます。 この ID は、次のチュートリアルでデータを調べるために必要です。

{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して PathFactory ベース接続を作成しました。このベース接続 ID は、次のチュートリアルで使用できます。

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089