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

メモ

この Generic OData コネクタはベータ版です。 詳しくは、 ソースの概要 ベータ版のコネクタの使用に関する詳細

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

このチュートリアルでは、Flow Service API を使用して、Generic OData のベース接続を作成する手順を説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

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

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

必要な認証情報の収集

Flow Service を Generic OData に接続するには、次の接続プロパティの値を指定する必要があります。

認証情報 説明
url のルート URL Generic OData サービス。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。Generic Generic OData の接続仕様 ID は 8e6b41a8-d998-4545-ad7d-c6a9fff406c3 です。

の導入について詳しくは、 この Generic OData 文書.

Platform API の使用

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

ベース接続の作成

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

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、Generic OData 認証資格情報をリクエストパラメーターの一部として使用します。

API 形式

POST /connections

リクエスト

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

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": "Protocols",
        "description": "A test connection for a Protocols source",
        "auth": {
            "specName": "Anonymous Authentication",
        "params": {
            "url":  "{URL}"
            }
        },
        "connectionSpec": {
            "id": "8e6b41a8-d998-4545-ad7d-c6a9fff406c3",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.url のホスト Generic OData サーバー。
connectionSpec.id この Generic OData 接続仕様 ID: 8e6b41a8-d998-4545-ad7d-c6a9fff406c3.

応答

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

{
    "id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
    "etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}

次の手順

このチュートリアルに従って、 Generic REST OData を使用したベース接続 Flow Service API このベース接続 ID は、次のチュートリアルで使用できます。

このページ