[Ultimate]{class="badge positive"}
Flow Service APIを使用してAmazon Kinesis ソース接続を作成する
このチュートリアルでは、 Flow Service API を使用して Amazon Kinesis（以下「Kinesis」）を Experience Platform に接続する手順を詳しく説明します。
はじめに
このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。
- ソース : Experience Platformを使用すると、様々なソースからデータを取り込むことができますが、Experience Platform サービスを使用して、着信データを構造化、ラベル付け、強化することができます。
- サンドボックス : Experience Platformは、1つのExperience Platform インスタンスを個別のバーチャル環境に分割し、デジタルエクスペリエンスアプリケーションの開発と進化に役立つバーチャルサンドボックスを提供します。
以下の節では、Flow Service APIを使用してKinesisをExperience Platformに正常に接続するために必要な追加情報を示します。
必要な資格情報の収集
Flow ServiceがAmazon Kinesis アカウントに接続するには、次の接続プロパティの値を指定する必要があります。
accessKeyIdsecretKeyregionconnectionSpec.id86043421-563b-46ec-8e6c-e23184711bf6 です。Kinesis個のアクセスキーとその生成方法について詳しくは、このAWS IAM ユーザーのアクセスキーの管理に関するガイド を参照してください。
Experience Platform APIの使用
Experience Platform APIの呼び出しを正常に行う方法について詳しくは、Experience Platform APIの概要に関するガイドを参照してください。
ベース接続の作成
ソース接続を作成する最初の手順は、Kinesis ソースを認証し、ベース接続 ID を生成することです。 ベース接続 ID を使用すると、ソース内を移動してファイルを探索し、データタイプや形式に関する情報など、取り込みたい特定の項目を識別できます。
ベース接続 ID を作成するには、/connections エンドポイントに対して POST リクエストを実行し、その際に Kinesis 認証資格情報をリクエストパラメーターの一部として指定します。
API 形式
POST /connections
リクエスト
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": "Amazon Kinesis connection",
"description": "Connector for Amazon Kinesis",
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"auth": {
"specName": "Aws Kinesis authentication credentials",
"params": {
"accessKeyId": "{ACCESS_KEY_ID}",
"secretKey": "{SECRET_KEY}",
"region": "{REGION}"
}
},
"connectionSpec": {
"id": "86043421-563b-46ec-8e6c-e23184711bf6",
"version": "1.0"
}
}'
auth.params.accessKeyIdauth.params.secretKeyauth.params.regionconnectionSpec.id86043421-563b-46ec-8e6c-e23184711bf6応答
リクエストが成功した場合は、一意の ID（id）を含め、新しく作成されたベース接続の詳細が返されます。 この ID は、次の手順でソース接続を作成する際に必要になります。
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
ソース接続の作成 source
ソース接続は、データの取り込み元となる外部ソースへの接続を作成および管理します。 ソース接続は、データソース、データフォーマット、データフローの作成に必要なソース接続IDなどの情報で構成されます。 ソース接続インスタンスは、テナントと組織に固有です。
ソース接続を作成するには、Flow Service API の /sourceConnections エンドポイントに POST リクエストを実行します。
API 形式
POST /sourceConnections
リクエスト
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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": "AWS Kinesis source connection",
"description": "A source connection for AWS Kinesis",
"baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
"connectionSpec": {
"id": "86043421-563b-46ec-8e6c-e23184711bf6",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"stream": "{STREAM}",
"dataType": "raw",
"reset": "latest"
}
}'
namedescriptionbaseConnectionIdconnectionSpec.id86043421-563b-46ec-8e6c-e23184711bf6 です。data.formatjson のみです。params.streamparams.dataTyperaw および xdm を含むデータタイプがサポートされています。params.resetlatestを使用して最新のデータから読み取りを開始し、earliestを使用してストリームの最初の利用可能なデータから読み取りを開始します。応答
リクエストが成功した場合は、新しく作成されたソース接続の一意の ID（id）が返されます。 この ID は、次のチュートリアルでデータフローを作成する際に必要です。
{
"id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
"etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}
次の手順
このチュートリアルでは、Flow Service API を使用して Kinesis ソース接続を作成しました。 次のチュートリアルでは、このソース接続 ID を使用して、 Flow Service API を使用したストリーミングデータフローの作成を行います。