APIを使用した Azure File StorageFlow Service コネクタの作成

メモ

コネクタ Azure File Storage はベータ版です。 ベータラベル付きのコネクタの使用について詳しくは、 ソースの概要 「」を参照してください。

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

このチュートリアルでは、 Flow Service APIを使用して、に接続する手順を順を追って説明 Azure File Storage し Experience Platformます。

はじめに

このガイドでは、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 Azure File Storage using the Flow Service API.

必要な資格情報の収集

と接続 Flow Service するには、次の接続プロパティの値を指定する必要があ Azure File Storageります。

Credential 説明
host アクセスする Azure File Storageインスタンスのエンドポイント。
userId エンドポイントへの十分なアクセス権を持つユー Azure File Storage ザー。
password インスタンスのパスワード Azure File Storage です
接続指定ID 接続を作成するために必要な一意の識別子。 の接続仕様ID Azure File Storage は次のとおりです。 be5ec48c-5b78-49d5-b8fa-7c89ec4569b8

開始方法の詳細については、 このAzure Fileストレージドキュメントを参照してください

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

接続の作成

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

API 形式

POST /connections

リクエスト

The following request creates a new Azure File Storage connection, configured by the properties provided in the payload:

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": "Azure File Storage connection",
        "description": "An Azure File Storage test connection",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                    "host": "{HOST}",
                    "userId": "{USER_ID}",
                    "password": "{PASSWORD}"
                }
        },
        "connectionSpec": {
            "id": "be5ec48c-5b78-49d5-b8fa-7c89ec4569b8",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.host アクセスしている Azure File Storage インスタンスのエンドポイント。
auth.params.userId エンドポイントへの十分なアクセス権を持つユー Azure File Storage ザー。
auth.params.password アク Azure File Storage セスキー。
connectionSpec.id 接続 Azure File Storage 指定ID: be5ec48c-5b78-49d5-b8fa-7c89ec4569b8.

応答

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

{
    "id": "f9377f50-607a-4818-b77f-50607a181860",
    "etag": "\"2f0276fa-0000-0200-0000-5eab3abb0000\""
}

次の手順

このチュートリアルに従うことで、 Azure File Storage APIを使用して Flow Service 接続を作成し、接続の一意のID値を取得しました。 このIDは、Flow Service APIを使用してサードパーティのクラウドストレージを 調査する方法を学習する際に、次のチュートリアルで使用できます

このページ