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

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

Flow Service APIを使用してPathFactoryのベース接続を作成する方法については、このドキュメントを参照してください。

基本を学ぶ

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

  • ​ ソース ​: Experience Platformを使用すると、様々なソースからデータを取り込むことができますが、Experience Platform サービスを使用して着信データを構造化、ラベル付け、強化することができます。
  • ​ サンドボックス ​: Experience Platformは、1つのExperience Platform インスタンスを個別のバーチャル環境に分割して、デジタルエクスペリエンスアプリケーションの開発と進化に役立つバーチャルサンドボックスを提供します。

Experience Platform APIの使用

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

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

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

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

資格情報
説明
ユーザー名
PathFactory アカウントのユーザー名。 これは、システム内のアカウントを特定するために不可欠です。
パスワード
PathFactory アカウントに関連付けられているパスワード。 不正アクセスを防ぐため、データのセキュリティを確保する。
ドメイン
PathFactory アカウントに関連付けられているドメイン。 これは通常、PathFactory URL内の一意の識別子を指します。
アクセストークン
システムと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統合を確実に行うための包括的なガイドを提供します。

ベース接続の作成

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

ベース接続IDを作成するには、PathFactory認証情報をリクエスト本文の一部として提供しながら、/connections エンドポイントにPOST リクエストを行います。

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
experience-platform-help-sources