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

最終更新日： 2025年10月14日

トピック：
Sources

作成対象：

Developer

NOTE

Generic REST API ソースはベータ版です。ベータ版のラベル付きコネクタの使用について詳しくは、ソースの概要を参照してください。

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

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

はじめに

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

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

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

必要な資格情報の収集

Flow ServiceがGeneric REST APIと接続するには、選択した認証タイプに有効な資格情報を指定する必要があります。 Generic REST APIは、OAuth 2更新コードと基本認証の両方をサポートしています。サポートされている2つの認証タイプの資格情報について詳しくは、次の表を参照してください。

OAuth 2更新コード

資格情報

説明

host

リクエストを行うソースのホスト URL。この値は必須であり、requestParameterOverrideを使用してバイパスすることはできません。

authorizationTestUrl

（オプション）認証テスト URL は、ベース接続の作成時に資格情報を検証するために使用されます。指定しない場合、代わりにソース接続の作成時に資格情報が自動的にチェックされます。

clientId

（オプション）ユーザーアカウントに関連付けられているクライアント ID。

clientSecret

（オプション）ユーザーアカウントに関連付けられたクライアントシークレット。

accessToken

アプリケーションへのアクセスに使用されるプライマリ認証資格情報。アクセストークンは、ユーザーのデータの特定の側面にアクセスするためのアプリケーションの認証を表します。この値は必須であり、requestParameterOverrideを使用してバイパスすることはできません。

refreshToken

（オプション）アクセストークンの有効期限が切れたときに、新しいアクセストークンを生成するために使用されるトークン。

expirationDate

（オプション）アクセストークンの有効期限を定義する非表示の値。

accessTokenUrl

（オプション）アクセストークンの取得に使用するURL エンドポイント。

requestParameterOverride

（オプション）上書きする資格情報パラメーターを指定できるプロパティ。

connectionSpec.id

接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。 Generic REST API の接続仕様 ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。

基本認証

資格情報

説明

host

リクエストを行うソースのホスト URL。

username

ユーザーアカウントに対応するユーザー名。

password

ユーザーアカウントに対応するパスワード。

connectionSpec.id

ベース接続の作成

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

Generic REST API は、基本認証と OAuth 2 更新コードの両方をサポートしています。いずれかの認証タイプで認証する方法については、次の例を参照してください。

OAuth 2 更新コードコードを使って Generic REST API ベース接続を作成します

OAuth 2更新コードを使用してベース接続IDを作成するには、OAuth 2資格情報を提供しながら、/connections エンドポイントにPOST リクエストを行います。

API 形式

POST /connections

リクエスト

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

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": "Generic REST API base connection with OAuth 2 refresh code",
      "description": "Generic REST API base connection with OAuth 2 refresh code",
      "connectionSpec": {
          "id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
          "version": "1.0"
      },
      "auth": {
          "specName": "oAuth2RefreshCode",
          "params": {
              "host": "{HOST}",
              "accessToken": "{ACCESS_TOKEN}"
          }
      }
  }'

プロパティ

説明

name

ベース接続の名前。ベース接続の情報を検索する際に使用できるので、ベース接続の名前はわかりやすいものにしてください。

description

（オプション）ベース接続に関する詳細情報を提供するために含めることができるプロパティ。

connectionSpec.id

Generic REST APIに関連付けられている接続仕様ID。この修正済み ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。

auth.specName

Experience Platformに対するソースの認証に使用する認証タイプ。

auth.params.host

Generic REST API ソースへの接続に使用されるルート URL。

auth.params.accessToken

ソースの認証に使用された、対応するアクセストークン。これは、OAuth ベースの認証に必要です。

応答

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

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

基本認証を使用した Generic REST API ベース接続の作成

基本認証を使用してGeneric REST API ベース接続を作成するには、基本認証情報を提供しながら、Flow Service APIの/connections エンドポイントにPOST リクエストを行います。

API 形式

POST /connections

リクエスト

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

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'
  -d '{
      "name": "Generic REST API base connection with basic authentication",
      "description": "Generic REST API base connection with basic authentication",
      "connectionSpec": {
          "id": "4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62",
          "version": "1.0"
      },
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "host": "{HOST}",
              "username": "{USERNAME}",
              "password": "{PASSWORD}"
          }
      }
  }'

プロパティ

説明

name

ベース接続の名前。ベース接続の情報を検索する際に使用できるので、ベース接続の名前はわかりやすいものにしてください。

description

（オプション）ベース接続に関する詳細情報を提供するために含めることができるプロパティ。

connectionSpec.id

Generic REST APIに関連付けられている接続仕様ID。この修正済み ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。

auth.specName

ソースをExperience Platformに接続するために使用する認証タイプ。

auth.params.host

Generic REST API ソースへの接続に使用されるルート URL。

auth.params.username

Generic REST API ソースに対応するユーザー名。これは、基本認証に必要です。

auth.params.password

Generic REST API ソースに対応するパスワード。これは、基本認証に必要です。

応答

リクエストが成功した場合は、一意の接続識別子（id）を含む、新しく作成されたベース接続が返されます。この ID は、次の手順でソースのファイル構造と内容を調べるために必要です。

{
    "id": "9601747c-6874-4c02-bb00-5732a8c43086",
    "etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}

次の手順

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

recommendation-more-help

experience-platform-help-sources