Show Menu
トピック×

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

コネクタ HubSpot はベータ版です。 ベータラベル付きのコネクタの使用について詳しくは、 ソースの概要 「」を参照してください。
Flow Service は、Adobe Experience Platform内のさまざまな異なるソースから顧客データを収集し、一元化するために使用されます。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。
このチュートリアルでは、 Flow Service APIを使用して、に接続する手順を順を追って説明 Experience Platform し HubSpotます。

はじめに

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

必要な資格情報の収集

と接続 Flow Service するには、次の接続プロパティを指定する必要があ HubSpotります。
Credential
説明
クライアントID
アプリケーションに関連付けられているクライアントID HubSpot 。
クライアントシークレット
アプリケーションに関連付けられているクライアントシークレット HubSpot です。
アクセストークン
OAuth統合を最初に認証する際に取得されるアクセストークン。
更新トークン
OAuth統合を最初に認証する際に取得される更新トークン。
接続指定ID
接続を作成するために必要な一意の識別子。 の接続指定ID HubSpot は次のとおりです。 cc6a4487-9e91-433e-a3a3-9cf6626c1806
使い始める前に、このHubSpotドキュメントを参照して ください

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

接続の作成

接続は、ソースを指定し、そのソースの資格情報を含みます。 異なるデータを取り込む複数のソースコネクタを作成する場合に使用できるので、 HubSpot アカウントごとに必要な接続は1つだけです。
API 形式
POST /connections

リクエスト
接続を作成するには、その HubSpot 一意の接続指定IDをPOST要求の一部として指定する必要があります。 の接続指定ID HubSpot はです cc6a4487-9e91-433e-a3a3-9cf6626c1806
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": "connection for hubspot",
        "description": "connection for hubspot",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "clientId": "{CLIENT_ID}",
                "clientSecret": "{CLIENT_SECRET}",
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }

プロパティ
説明
auth.params.clientId
アプリケーションに関連付けられているクライアントID HubSpot 。
auth.params.clientSecret
アプリケーションに関連付けられているクライアントシークレット HubSpot です。
auth.params.accessToken
OAuth統合を最初に認証する際に取得されるアクセストークン。
auth.params.refreshToken
OAuth統合を最初に認証する際に取得される更新トークン。
応答  
正常な応答は、新たに作成されたAPI用の接続の詳細(一意の識別子( id )を含む)を返します。 このIDは、次のチュートリアルでデータを調べるために必要です。
{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

このチュートリアルに従うことで、 HubSpot APIを使用して Flow Service 接続を作成し、接続の一意のID値を取得しました。 Flow Service APIを使用してマーケティング自動化システムを 調査する方法について学習する際に、次のチュートリアルでこの接続IDを使用できます