Flow Service APIを使用してAmazon S3コネクタを作成する

Flow Service は、Adobe Experience Platform内のさまざまな異なるソースから顧客データを収集し、一元化するために使用されます。このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。

このチュートリアルでは、Flow Service APIを使用してExperience PlatformをAmazon S3(以下「S3」と呼びます)ストレージに接続する手順を順を追って説明します。

Experience Platformでユーザインターフェイスを使用したい場合は、AmazonS3ソースコネクタUIチュートリアルで、同様の操作を実行するための手順を順を追って説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する作業を理解している必要があります。

  • ソース: Experience Platform 様々なソースからデータを取り込むことができ、 Platform サービスを使用してデータの構造化、ラベル付け、および入力データの拡張を行うことができます。
  • サンドボックス: Experience Platform は、1つの Platform インスタンスを個別の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

Flow Service APIを使用してS3ストレージに正しく接続するために必要な追加情報については、以下の節で説明します。

必要な資格情報の収集

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

Credential 説明
s3AccessKey S3ストレージのアクセスキーID。
s3SecretKey S3ストレージの秘密鍵ID。

開始方法の詳細については、このAWSドキュメントを参照してください。

API 呼び出し例の読み取り

このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。この中には、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform

必須ヘッダーの値の収集

Platform APIを呼び出すには、まず認証チュートリアルを完了する必要があります。 次に示すように、すべてのExperience Platform API呼び出しに必要な各ヘッダーの値を認証チュートリアルで説明します。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform内のすべてのリソース(Flow Serviceに属するリソースを含む)は、特定の仮想サンドボックスに分離されます。 Platform APIへのすべてのリクエストには、操作が行われるサンドボックスの名前を指定するヘッダーが必要です。

  • x-sandbox-name: {SANDBOX_NAME}

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

接続の作成

接続は、ソースを指定し、そのソースの資格情報を含みます。 S3アカウントごとに1つの接続のみが必要です。異なるデータを取り込むために複数のソースコネクタを作成するのに使用できます。

API 形式

POST /connections

リクエスト

S3接続を作成するには、POST要求の一部として一意の接続仕様IDを指定する必要があります。 S3の接続指定IDはecadc60c-7455-4d87-84dc-2a0e293d997bです。

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "S3 Connection",
        "description": "Connection for an Amazon S3 account",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}"
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.s3AccessKey S3ストレージに関連付けられているアクセスキー。
auth.params.s3SecretKey S3ストレージに関連付けられている秘密鍵。
connectionSpec.id S3ストレージ接続仕様ID:ecadc60c-7455-4d87-84dc-2a0e293d997b

応答

正常に応答すると、新たに作成された接続の詳細(一意の識別子(id)が返されます。 このIDは、次のチュートリアルでストレージを調べるために必要です。

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

次の手順

このチュートリアルに従うと、APIを使用してS3接続が作成され、一意のIDが応答本文の一部として取得されます。 この接続IDを使用して、Flow Service API](…/…/explore/cloud-storage.md)またはFlow Service APIを使用したインジェストパーケットデータを使用して、[クラウドストレージを探索できます。

このページ