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

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

このチュートリアルでは、のベース接続を作成する手順を説明します。 Amazon S3 (以下「」という。)S3」) Flow Service API.

はじめに

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

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

以下の節では、 S3 を使用したストレージ Flow Service API

必要な認証情報の収集

次のために Flow Service を S3 ストレージの場合は、次の接続プロパティの値を指定する必要があります。

認証情報 説明
s3AccessKey のアクセスキー ID S3 バケット。
s3SecretKey の秘密鍵 ID S3 バケット。
serviceUrl (オプション)カスタム S3 接続先のエンドポイント。 このフィールドは、 S3 bucket は地域固有です。 の形式 serviceUrl 次に該当: https://s3.{REGION}.amazonaws.com/).
bucketName この S3 bucket には、データと、対応する記述メタデータが含まれます。 お使いの S3 バケット名は 3 ~ 63 文字の長さで、先頭と末尾には文字または数字を使用する必要があります。 バケット名に使用できるのは、小文字、数字、ハイフン (-) で始まり、IP アドレス形式にすることはできません。
folderPath フォルダーのパス ( S3 バケットに保存します。 この資格情報は、ユーザーがアクセスを制限している場合に必要です。
s3SessionToken (オプション)短期間で一時的なトークン。 S3 信頼できない環境のユーザーに対するリソース。 詳しくは、S3 概要を参照してください。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。S3 の接続仕様 ID は ecadc60c-7455-4d87-84dc-2a0e293d997b です。

使い始める方法について詳しくは、 この Amazon Web Services 文書.

Platform API の使用

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

ベース接続の作成

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

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

API 形式

POST /connections

リクエスト

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

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 S3 base connection",
        "description": "Amazon S3 base connection with temporary session token",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}",
                "s3SessionToken": "{S3_SESSION_TOKEN}
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.s3AccessKey に関連付けられたアクセスキー S3 バケット。
auth.params.s3SecretKey に関連付けられた秘密鍵 S3 バケット。
auth.params.s3SessionToken (オプション)短期の一時的な S3 バケットへのアクセスに使用するトークン。
connectionSpec.id この S3 接続仕様 ID: ecadc60c-7455-4d87-84dc-2a0e293d997b

応答

リクエストが成功した場合は、一意の ID(id)を含む、新しく作成した接続の詳細が返されます。この ID は、次のチュートリアルでストレージを参照するために必要です。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

次の手順

このチュートリアルでは、API を使用して S3 接続を作成し、応答本文の一部として一意の ID を取得しました。 この接続 ID を フローサービス API を使用したクラウドストレージの調査.

付録

次の節では、 S3 ソース。

の更新 S3 セッショントークン

この s3SessionToken は一時的で、有効期限が切れたときに更新する必要があります。 に対してPATCHリクエストを実行することで、ベース接続に関連付けられたセッショントークンを更新できます。 Flow Service API 詳しくは、 S3 概要 の一時的なセキュリティ認証情報の詳細 S3.

重要

If-Match ヘッダーは、PATCH リクエストを行う際に必要です。このヘッダーの値は、更新する接続の一意の ETag です。

API 形式

PATCH /connections

リクエスト

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

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
    -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}' \
    -H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
    -d '[
        {
            "op": "replace",
            "path": "/auth/params/s3SessionToken",
            "value": "{SESSION_TOKEN}"
        }
    ]'
パラメーター 説明
op 接続の更新に必要なアクションを定義するために使用される操作呼び出し。操作には、addreplaceremove があります。
path 更新するパラメーターのパス。
value パラメーターの更新に使用する新しい値。

応答

正常な応答では、ベース接続 ID と更新された etag が返されます。Flow Service API に GET リクエストを実行し、その際に接続 ID を指定することで、更新を検証できます。

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

このページ