Generic REST API ソースはベータ版です。詳しくは、 ソースの概要 ベータ版のコネクタの使用に関する詳細
ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。
このチュートリアルでは、Flow Service API を使用して、Generic REST API のベース接続を作成する手順を説明します。
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
Platform API を正常に呼び出す方法について詳しくは、Platform API の概要のガイドを参照してください。
次のために Flow Service ~とつながる Generic REST APIを使用する場合は、選択した認証タイプに有効な資格情報を指定する必要があります。 Generic REST API は、OAuth 2 更新コードと基本認証の両方をサポートしています。 サポートされる 2 つの認証タイプの資格情報については、次の表を参照してください。
資格情報 | 説明 |
---|---|
host |
リクエスト先のソースのホスト URL。 この値は必須で、 requestParameterOverride . |
authorizationTestUrl |
(オプション)認証テスト URL は、ベース接続の作成時に認証情報を検証するために使用されます。指定しない場合、代わりにソース接続の作成時に資格情報が自動的にチェックされます。 |
clientId |
(オプション)ユーザーアカウントに関連付けられたクライアント ID。 |
clientSecret |
(オプション)ユーザーアカウントに関連付けられたクライアント秘密鍵。 |
accessToken |
アプリケーションへのアクセスに使用するプライマリ認証資格情報。 アクセストークンは、ユーザーのデータの特定の側面にアクセスするための、アプリケーションの認証を表します。 この値は必須で、 requestParameterOverride . |
refreshToken |
(オプション)アクセストークンの有効期限が切れたときに、新しいアクセストークンの生成に使用されるトークン。 |
expirationDate |
(オプション)アクセストークンの有効期限を定義する hidden 値です。 |
accessTokenUrl |
(オプション)アクセストークンの取得に使用する URL エンドポイント。 |
requestParameterOverride |
(オプション)上書きする秘密鍵証明書のパラメーターを指定できるプロパティ。 |
connectionSpec.id |
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Generic REST API の接続仕様 ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。 |
資格情報 | 説明 |
---|---|
host |
リクエスト先のソースのホスト URL。 |
username |
ユーザーアカウントに対応するユーザー名。 |
password |
ユーザーアカウントに対応するパスワード。 |
connectionSpec.id |
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。Generic REST API の接続仕様 ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。 |
ベース接続は、ソースと Platform 間の情報(ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など)を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。
Generic REST API は、基本認証と OAuth 2 更新コードの両方をサポートしています。いずれかの認証タイプで認証する方法については、次の例を参照してください。
OAuth 2 更新コードを使用してベース接続 ID を作成するには、 /connections
エンドポイントが OAuth 2 資格情報を指定しています。
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 |
次に関連付けられた接続仕様 ID Generic REST API. この修正済み ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。 |
auth.specName |
Platform へのソースの認証に使用する認証タイプ。 |
auth.params.host |
の Generic REST API ソース。 |
auth.params.accessToken |
ソースの認証に使用された、対応するアクセストークン。これは、OAuth ベースの認証に必要です。 |
応答
正常な応答は、新しく作成された接続を返します。この接続には、一意の接続識別子 (id
) をクリックします。 この ID は、次のチュートリアルでデータを調べるために必要です。
{
"id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}
を作成するには、以下を実行します。 Generic REST API 基本認証を使用したベース接続、 /connections
エンドポイント Flow Service 基本認証資格情報を入力する際の API。
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 |
次に関連付けられた接続仕様 ID Generic REST API. この修正済み ID は 4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62 です。 |
auth.specName |
ソースを Platform に接続するために使用する認証タイプ。 |
auth.params.host |
の Generic REST API ソース。 |
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 は、次のチュートリアルで使用できます。