を使用した汎用 REST API ベース接続の作成 Flow Service 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 つの認証タイプの資格情報については、次の表を参照してください。
OAuth 2 更新コード
host
requestParameterOverride
.authorizationTestUrl
clientId
clientSecret
accessToken
requestParameterOverride
.refreshToken
expirationDate
accessTokenUrl
requestParameterOverride
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
です。基本認証
host
username
password
connectionSpec.id
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
です。ベース接続の作成
ベース接続は、ソースと Platform 間の情報(ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など)を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。
Generic REST API は、基本認証と OAuth 2 更新コードの両方をサポートしています。いずれかの認証タイプで認証する方法については、次の例を参照してください。
OAuth 2 更新コードコードを使って Generic REST API ベース接続を作成します
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
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
です。auth.specName
auth.params.host
auth.params.accessToken
応答
正常な応答は、新しく作成された接続を返します。この接続には、一意の接続識別子 (id
) をクリックします。 この ID は、次のチュートリアルでデータを調べるために必要です。
{
"id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
"etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}
基本認証を使用した Generic REST API ベース接続の作成
を作成するには、以下を実行します。 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
4e98f16f-87d6-4ef0-bdc6-7a2b0fe76e62
です。auth.specName
auth.params.host
auth.params.username
auth.params.password
応答
リクエストが成功した場合は、一意の接続識別子(id
)を含む、新しく作成されたベース接続が返されます。この ID は、次の手順でソースのファイル構造と内容を調べるために必要です。
{
"id": "9601747c-6874-4c02-bb00-5732a8c43086",
"etag": "\"3702dabc-0000-0200-0000-615b5b5a0000\""
}
次の手順
このチュートリアルでは、Flow Service API を使用して Generic REST API ベース接続を作成しました。このベース接続 ID は、次のチュートリアルで使用できます。