Flow Service API を使用した SugarCRM Accounts & Contacts のソース接続とデータフローの作成
以下のチュートリアルでは、SugarCRM Accounts & Contacts ソース接続を作成し、Flow Service API を使用してアカウントと連絡先のデータをAdobe Experience Platformに取り SugarCRM むデータフローを作成する手順を詳しく説明します。
はじめに
このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。
次の節では、Flow Service API を使用してに正常に接続するために必要な追加情報を示 SugarCRM ています。
必要な資格情報の収集
SugarCRM Accounts & Contacts をExperience Platformに接続するには、次の接続プロパティの値を指定する必要があります。
資格情報
説明
例
hostソースが接続する SugarCRM API エンドポイント。
developer.salesfusion.comusernameSugarCRM 開発者アカウントのユーザー名。
abc.def@example.com@sugarmarketdemo000.compasswordSugarCRM 開発者アカウントのパスワード。
123456789Flow Service API を使用した SugarCRM Accounts & Contacts のExperience Platformへの接続
次に、SugarCRM ソースの認証、ソース接続の作成、アカウントと連絡先のデータをExperience Platformに取り込むためのデータフローの作成を行うために必要な手順の概要を説明します。
ベース接続の作成 base-connection
ベース接続は、ソースとExperience Platform間の情報（ソースの認証資格情報、現在の接続状況、一意のベース接続 ID など）を保持します。 ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。
ベース接続 ID を作成するには、/connections エンドポイントに対して POST リクエストを実行し、その際に SugarCRM Accounts & Contacts 認証資格情報をリクエスト本文の一部として指定します。
API 形式
POST /connections
リクエスト
次のリクエストは、SugarCRM Accounts & Contacts のベース接続を作成します。
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: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SugarCRM Accounts & Contacts base connection",
"description": "Create a live inbound connection to your SugarCRM Accounts & Contacts instance, to ingest both historic and scheduled data into Experience Platform",
"connectionSpec": {
"id": "59a4b493-a615-40f9-bd38-f823d0909a2b",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Refresh Code",
"params": {
"host": "developer.salesfusion.com",
"username": "{SUGARCRM_DEVELOPER_ACCOUNT_USERNAME}",
"password": "{SUGARCRM_DEVELOPER_ACCOUNT_PASSWORD}"
}
}
}'
プロパティ
説明
nameベース接続の名前。ベース接続の情報を検索する際に使用できるので、ベース接続の名前はわかりやすいものにしてください。
description含めることでベース接続に関する詳細情報を提供できるオプションの値です。
connectionSpec.idソースの接続仕様 ID。この ID は、ソースが登録および承認された後に、Flow Service API から取得することができます。
auth.specNameExperience Platformに対するソースの認証に使用する認証タイプ。
auth.params.hostSugarCRM API ホスト：developer.salesfusion.com
auth.params.usernameSugarCRM 開発者アカウントのユーザー名。
auth.params.passwordSugarCRM 開発者アカウントのパスワード。
応答
リクエストが成功した場合は、一意の接続識別子（id）を含む、新しく作成されたベース接続が返されます。この ID は、次の手順でソースのファイル構造と内容を調べるために必要です。
{
"id": "f5421911-6f6c-41c7-aafa-5d9d2ce51535",
"etag": "\"4d08164f-0000-0200-0000-6368b7bf0000\""
}
ソースを参照 explore
前の手順で生成したベース接続 ID を使用すると、GET リクエストを実行してファイルとディレクトリを調べることができます。
次の呼び出しを使用して、Experience Platformに取り込むファイルのパスを検索します。
API 形式
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
ソースのファイル構造とコンテンツを調べるために GET リクエストを実行する場合、次の表に示すクエリのパラメーターを含める必要があります。
パラメーター
説明
{BASE_CONNECTION_ID}前の手順で生成したベース接続 ID。
objectType=rest参照するオブジェクトのタイプ。 現在、この値は常に
rest に設定されています。{OBJECT}このパラメーターは、特定のディレクトリを表示する場合にのみ必要です。 値は、参照するディレクトリのパスを表します。 このソースの場合、値は
json になります。fileType=jsonExperience Platformに取り込むファイルのファイルタイプ。 現在、サポートされているファイルタイプは
json のみです。{PREVIEW}接続のコンテンツがプレビューをサポートするかどうかを定義するブール値です。
{SOURCE_PARAMS}Experience Platformに取り込むソースファイルのパラメーターを定義します。 {SOURCE_PARAMS} で受け入れ可能な形式タイプを取得するには、文字列全体を base64 にエンコードする必要があります。
SugarCRM Accounts & Contacts は複数の API をサポートしています。 活用するオブジェクトのタイプに応じて、次のいずれかを渡します。
accounts：組織と関係がある会社。contacts：組織と関係が確立されている個人。
SugarCRM Accounts & Contacts は複数の API をサポートしています。 送信するリクエストを活用しているオブジェクトタイプに応じて、次のリクエストを行います。
リクエスト
アカウント
SugarCRM Accounts API の場合、{SOURCE_PARAMS} の値は {"object_type":"accounts"} として渡されます。 base64 でエンコードされた場合、次に示すように、eyJvYmplY3RfdHlwZSI6ImFjY291bnRzIn0= と等しくなります。
| code language-shell |
|---|
|
連絡先
Contacts APISugarCRM 場合、{SOURCE_PARAMS} の値は {"object_type":"contacts"} として渡されます。 base64 でエンコードされた場合、次に示すように、eyJvYmplY3RfdHlwZSI6ImNvbnRhY3RzIn0= と等しくなります。
| code language-shell |
|---|
|
応答
同様に、受信した応答を活用しているオブジェクトタイプに応じて、次のようになります。
NOTE
プレゼンテーションを向上させるために、一部のレコードが切り捨てられました。
アカウント
応答が成功すると、次のような構造が返されます。
| code language-json |
|---|
|
連絡先
応答が成功すると、次のような構造が返されます。
| code language-json |
|---|
|
ソース接続の作成 source-connection
Flow Service API に対して POST リクエストを実行することで、ソース接続を作成することができます。ソース接続は、接続 ID、ソースデータファイルへのパス、接続仕様 ID から構成されます。
API 形式
POST /sourceConnections
リクエスト
次のリクエストは、SugarCRM Accounts & Contacts のソース接続を作成します。
活用するオブジェクトのタイプに応じて、次のタブから選択します。
アカウント
SugarCRM Accounts API の場合、object_type プロパティ値を accounts にする必要があります。
| code language-shell |
|---|
|
連絡先
Contacts APISugarCRM 場合、object_type プロパティ値は contacts にする必要があります。
| code language-shell |
|---|
|
プロパティ
説明
nameソース接続の名前。 ソース接続の情報を検索する際に使用できるので、ソース接続の名前はわかりやすいものにしてください。
description含めることでソース接続に関する詳細情報を提供できるオプションの値です。
baseConnectionIdSugarCRM Accounts & Contacts のベース接続 ID。この ID は、前の手順で生成されました。
connectionSpec.idソースに対応する接続仕様の ID。
data.format取り込む SugarCRM Accounts & Contacts データの形式。現在、サポートされているデータ形式は
json のみです。object_typeSugarCRM Accounts & Contacts は複数の API をサポートしています。 活用するオブジェクトのタイプに応じて、次のいずれかを渡します。
accounts：組織と関係がある会社。contacts：組織と関係が確立されている個人。
pathこれにより、
object_type に選択した値と同じ値が設定されます。応答
リクエストが成功した場合は、新たに作成されたソース接続の一意の ID（id）が返されます。この ID は、後の手順でデータフローを作成する際に必要になります。
{
"id": "8f1fc72a-f562-4a1d-8597-85b5ca1b1cd3",
"etag": "\"ed05f1e1-0000-0200-0000-6368b8710000\""
}
ターゲット XDM スキーマの作成 target-schema
ソースデータをExperience Platformで使用するには、必要に応じてターゲットスキーマを作成してソースデータを構造化する必要があります。 次に、ターゲットスキーマを使用して、ソースデータが含まれるExperience Platform データセットが作成されます。
Schema Registry API に POST リクエストを実行することで、ターゲット XDM スキーマを作成できます。
ターゲット XDM スキーマの作成手順について詳しくは、 API を使用したスキーマの作成に関するチュートリアルを参照してください。
ターゲットデータセットの作成 target-dataset
Catalog Service API に POST リクエストを実行し、その際にペイロード内でターゲットスキーマの ID を指定することで、ターゲットデータセットを作成できます。
ターゲットデータセットの作成手順について詳しくは、 API を使用したデータセットの作成に関するチュートリアルを参照してください。
ターゲット接続の作成 target-connection
ターゲット接続は、取り込まれたデータが保存される宛先への接続を表します。 ターゲット接続を作成するには、データレイクに対応する固定接続仕様 ID を指定する必要があります。 この ID は c604ff05-7f1a-43c0-8e18-33bf874cb11c です。
これで、一意の識別子、ターゲットスキーマ、ターゲットデータセット、およびデータレイクに対する接続仕様 ID が得られました。 これらの識別子を使用すると、受信ソースデータを格納するデータセットを指定する Flow Service API を使用して、ターゲット接続を作成することができます。
API 形式
POST /targetConnections
リクエスト
次のリクエストは、SugarCRM Accounts & Contacts のターゲット接続を作成します。
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SugarCRM Target Connection Generic Rest",
"description": "SugarCRM Target Connection Generic Rest",
"connectionSpec": {
"id": "63d2b27b-69a5-45c9-a7fe-78148a25de3c",
"version": "1.0"
},
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/b156e6f818f923e048199173c45e55e20fd2487f5eb03d22",
"version": "1.22"
}
},
"params": {
"dataSetId": "6365389d1d37d01c077a81da"
}
}'
プロパティ
説明
nameターゲット接続の名前。ターゲット接続の情報を検索に使用できるように、ターゲット接続はわかりやすい名前にしてください。
descriptionターゲット接続に関する詳細を提供するために含めることができるオプションの値です。
connectionSpec.idデータレイクに対応する接続仕様 ID。 この修正済み ID は
6b137bf6-d2a0-48c8-914b-d50f4942eb85 です。data.format取り込む SugarCRM Accounts & Contacts データの形式。
params.dataSetId前の手順で取得したターゲットデータセット ID。
応答
リクエストが成功した場合は、新しいターゲット接続の一意の ID（id）が返されます。この ID は、後の手順で必要になります。
{
"id": "6b137bf6-d2a0-48c8-914b-d50f4942eb85",
"etag": "\"8405a268-0000-0200-0000-6368b8c30000\""
}
マッピングの作成 mapping
ソースデータをターゲットデータセットに取り込むには、まず、ターゲットデータセットが準拠するターゲットスキーマにマッピングする必要があります。これを実現するには、リクエストペイロード内で定義されたデータマッピングを使用して、Data Prep API に対して POST リクエストを実行します。
API 形式
POST /conversion/mappingSets
リクエスト
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/b156e6f818f923e048199173c45e55e20fd2487f5eb03d22",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "results.account",
"destination": "_extconndev.account"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.account_id",
"destination": "_extconndev.account_id"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.acount_name",
"destination": "_extconndev.account_name"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.account_score",
"destination": "_extconndev.account_score"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.billing_city",
"destination": "_extconndev.billing_city"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.contacts",
"destination": "_extconndev.contacts"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.created_by",
"destination": "_extconndev.created_by"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.created_by_id",
"destination": "_extconndev.created_by_id"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.created_date",
"destination": "_extconndev.created_date"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.custom_score_field",
"destination": "_extconndev.custom_score_field"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.key_account",
"destination": "_extconndev.key_account"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.owner",
"destination": "_extconndev.owner"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.owner_id",
"destination": "_extconndev.owner_id"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.phone",
"destination": "_extconndev.phone_no"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.updated_by",
"destination": "_extconndev.updated_by"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.updated_by_id",
"destination": "_extconndev.updated_by_id"
},
{
"sourceType": "ATTRIBUTE",
"source": "results.updated_date",
"destination": "_extconndev.updated_date"
}
]
}'
プロパティ
説明
outputSchema.schemaRef.id以前の手順で生成されたターゲット XDM スキーマの ID。
mappings.sourceTypeマッピングされるソース属性タイプ。
mappings.source宛先 XDM パスにマッピングする必要があるソース属性。
mappings.destinationソース属性がマッピングされている宛先 XDM パス。
応答
リクエストが成功した場合は、一意の ID（id）を含む、新しく作成されたマッピングの詳細が返されます。この値は、後の手順でデータフローを作成する際に必要になります。
{
"id": "059c69f7207b4d7e9b48c47e2fd966a6",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
フローの作成 flow
SugarCRM Accounts & Contacts からExperience Platformにデータを取り込むための最後の手順は、データフローを作成することです。 現時点で、次の必要な値の準備ができています。
データフローは、ソースからデータをスケジュールおよび収集する役割を果たします。ペイロードに前述の値を提供しながら POST リクエストを実行することで、データフローを作成することができます。
取り込みをスケジュールするには、まず開始時刻の値をエポック時間（秒）に設定する必要があります。次に、頻度の値を hour または day のいずれかに設定する必要があります。 インターバルの値は、2 つの連続した取り込みの間隔を指定します。 間隔の値は、hour または day の選択に応じて 1 または 24 scheduleParams.frequency 設定する必要があります。
API 形式
POST /flows
リクエスト
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "SugarCRM Connector Description Flow Generic Rest",
"description": "SugarCRM Connector Description Flow Generic Rest",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"8f1fc72a-f562-4a1d-8597-85b5ca1b1cd3"
],
"targetConnectionIds": [
"6b137bf6-d2a0-48c8-914b-d50f4942eb85"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "059c69f7207b4d7e9b48c47e2fd966a6",
"mappingVersion": "0"
}
}
],
"scheduleParams": {
"startTime": "1625040887",
"frequency": "hour",
"interval": 1
}
}'
プロパティ
説明
nameデータフローの名前。データフローの情報を検索する際に使用できるので、データフローはわかりやすい名前にしてください。
descriptionデータフローの詳細を提供するために含めることができるオプションの値です。
flowSpec.idデータフローの作成に必要なフロー仕様 ID。この修正済み ID は
6499120c-0b15-42dc-936e-847ea3c24d72 です。flowSpec.versionフロー仕様 ID の対応するバージョン。この値のデフォルトは
1.0 です。sourceConnectionIds以前の手順で生成されたソース接続 ID。
targetConnectionIds以前の手順で生成されたターゲット接続 ID。
transformationsこのプロパティには、データに適用する必要がある様々な変換が含まれています。このプロパティは、XDM に準拠していないデータをExperience Platformに取り込む場合に必要です。
transformations.name変換に割り当てられた名前。
transformations.params.mappingId以前の手順で生成されたマッピング ID。
transformations.params.mappingVersionマッピング ID の対応するバージョン。この値のデフォルトは
0 です。scheduleParams.startTimeこのプロパティには、データフローの取り込みスケジュールに関する情報が含まれています。
scheduleParams.frequencyデータフローがデータを収集する頻度。指定できる値は
hour または day です。scheduleParams.intervalインターバルは 2 つの連続したフロー実行の間隔を指定します。インターバルの値はゼロ以外の整数にしてください。間隔の値は、
hour または day の選択に応じて 1 または 24 scheduleParams.frequency 設定する必要があります。応答
正常な応答は、新しく作成したデータフローの ID（id）を返します。この ID を使用して、データフローを監視、更新または削除できます。
{
"id": "fcd16140-81b4-422a-8f9a-eaa92796c4f4",
"etag": "\"9200a171-0000-0200-0000-6368c1da0000\""
}
付録
次の節では、データフローの監視、更新、削除を行う手順について説明します。
データフローの監視
データフローが作成されると、それを通して取り込まれるデータを監視し、フローの実行状況、完了状況、エラーなどの情報を確認することができます。完全な API の例については、API を使用したソースデータフローのモニタリングに関するガイドを参照してください。
データフローの更新
データフローの ID を指定しながら、API の /flows エンドポイントに対してPATCH リクエストを実行することで、名前や説明、実行スケジュールおよび関連するマッピングセットなど、データフローの詳細 Flow Service 更新します。 PATCH リクエストを行う場合は、データフローの一意の etag を If-Match ヘッダーで指定する必要があります。 完全な API の例については、API を使用したソースデータフローの更新に関するガイドを参照してください
アカウントを更新
ベース接続 ID をクエリパラメーターとして指定して Flow Service API に対してPATCH リクエストを実行することで、ソースアカウントの名前、説明、資格情報を更新します。 PATCH リクエストを行う場合は、ソースアカウントの一意の etag を If-Match ヘッダーで指定する必要があります。 完全な API の例については、API を使用したソースアカウントの更新に関するガイドを参照してください。
データフローの削除
クエリパラメーターの一部として削除するデータフローの ID を指定したうえで Flow Service API に対してDELETE リクエストを実行することで、データフローを削除します。 完全な API の例については、API を使用したデータフローの削除に関するガイドを参照してください。
アカウントを削除
Flow Service API にDELETE リクエストを実行し、その際に削除するアカウントのベース接続 ID を指定することで、アカウントを削除します。 完全な API の例については、API を使用したソースアカウントの削除に関するガイドを参照してください。
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089