APIを使用して Salesforce Service CloudFlow Service コネクタを作成する

メモ

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

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

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

はじめに

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

必要な資格情報の収集

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

Credential 説明
username ユーザーアカウントのユーザー名です。
password ユーザーアカウントのパスワードです。
securityToken ユーザーアカウントのセキュリティトークン。

使い始める前に詳しくは、 このSalesforce Service Cloudドキュメントを参照してください

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 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

接続仕様の検索

SSC接続を作成するには、SSC接続仕様のセットが内に存在する必要があり Flow Serviceます。 SSCに接続する最初の手順 Platform は、これらの仕様を取得することです。

API 形式

使用可能な各ソースには、認証要件などのコネクタプロパティを記述するための固有の接続仕様のセットがあります。 GET要求を /connectionSpecs エンドポイントに送信すると、使用可能なすべてのソースの接続仕様が返されます。 また、SSC専用の情報を取得す property=name=="salesforce-service-cloud" るクエリを含めることもできます。

GET /connectionSpecs
GET /connectionSpecs?property=name=="salesforce-service-cloud"

リクエスト

次のリクエストは、SSCの接続仕様を取得します。

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="mysql"' \
    -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}'

応答

正常に応答すると、固有な識別子(id)を含むSSCの接続仕様が返されます。 このIDは、次のベース接続を作成する手順で必要になります。

{
    "items": [
        {
            "id": "cb66ab34-8619-49cb-96d1-39b37ede86ea",
            "name": "salesforce-service-cloud",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication",
                    "type": "BasicAuthentication",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params",
                        "properties": {
                            "environmentUrl": {
                                "type": "string",
                                "description": "URL of the source instance"
                            },
                            "username": {
                                "type": "string",
                                "description": "User name for the user account"
                            },
                            "password": {
                                "type": "string",
                                "description": "Password for the user account",
                                "format": "password"
                            },
                            "securityToken": {
                                "type": "string",
                                "description": "Security token for the user account",
                                "format": "password"
                            }
                        },
                        "required": [
                            "username",
                            "password",
                            "securityToken"
                        ]
                    }
                }
            ],
        }
    ]
}

ベース接続を作成する

ベース接続はソースを指定し、そのソースの資格情報を含みます。 異なるデータを取り込むために複数のソースコネクタを作成する場合に使用できるので、SSCアカウントごとに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": "Base connection for salesforce service cloud",
        "description": "Base connection for salesforce service cloud",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                "username": "{USERNAME}",
                "password": "{PASSWORD}",
                "securityToken": "{SECURITY_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "b66ab34-8619-49cb-96d1-39b37ede86ea",
            "version": "1.0"
        }
    }'
パラメーター 説明
auth.params.username SSCアカウントに関連付けられているユーザ名。
auth.params.password SSCアカウントに関連付けられているパスワード。
auth.params.securityToken SSCアカウントに関連付けられているセキュリティトークン。
connectionSpec.id 前の手順で取得したSSCアカウント id の接続仕様。

応答

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

{
    "id": "4267c2ab-2104-474f-a7c2-ab2104d74f86",
    "etag": "\"0200f1c5-0000-0200-0000-5e4352bf0000\""
}

次の手順

このチュートリアルに従うことで、 Flow Service APIを使用してSSCベースの接続を作成し、接続の固有のID値を取得しました。 Flow Service APIを使用して顧客の成功システムを 調査する方法について学習する際に、次のチュートリアルでこの基本接続IDを使用できます

このページ