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

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

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

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

はじめに

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

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

The following sections provide additional information that you will need to know in order to successfully connect to an S3 storage using the Flow Service API.

必要な資格情報の収集

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

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

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

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

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

All resources in Experience Platform, including those belonging to the Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

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

  • Content-Type: application/json

接続の作成

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

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: {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を使用してクラウドストレージを 調べたり、Flow Service APIを使用してパーケーデータを 取り込んだりできます

このページ