흐름 서비스 API를 사용하여 SugarCRM Accounts & Contacts에 대한 소스 연결 및 데이터 흐름을 만듭니다.
다음 자습서에서는 Flow Service API를 사용하여 SugarCRM 계정 및 연락처 데이터를 Adobe Experience Platform으로 가져오기 위해 SugarCRM Accounts & Contacts 소스 연결을 만들고 데이터 흐름을 만드는 단계를 안내합니다.
시작하기
이 안내서를 사용하려면 다음 Experience Platform 구성 요소에 대해 이해하고 있어야 합니다.
다음 섹션에서는 Flow Service API를 사용하여 SugarCRM에 성공적으로 연결하기 위해 알아야 할 추가 정보를 제공합니다.
필요한 자격 증명 수집
SugarCRM Accounts & Contacts을(를) 플랫폼에 연결하려면 다음 연결 속성에 대한 값을 제공해야 합니다.
자격 증명
설명
예
host소스가 연결되는 SugarCRM API 엔드포인트.
developer.salesfusion.comusernameSugarCRM 개발자 계정 사용자 이름입니다.
abc.def@example.com@sugarmarketdemo000.compasswordSugarCRM 개발자 계정 암호입니다.
123456789Flow Service API를 사용하여 SugarCRM Accounts & Contacts을(를) 플랫폼에 연결
다음은 SugarCRM 원본을 인증하고, 원본 연결을 만들고, 데이터 흐름을 만들어 계정과 연락처 데이터를 Experience Platform 상태로 만드는 데 필요한 단계를 간략하게 설명합니다.
기본 연결 만들기 base-connection
기본 연결은 소스의 인증 자격 증명, 연결의 현재 상태 및 고유한 기본 연결 ID를 포함하여 소스와 플랫폼 간에 정보를 유지합니다. 기본 연결 ID를 사용하면 소스 내에서 파일을 탐색 및 탐색하고 데이터 유형 및 형식에 대한 정보를 포함하여 수집할 특정 항목을 식별할 수 있습니다.
기본 연결 ID를 만들려면 SugarCRM Accounts & Contacts 인증 자격 증명을 요청 본문의 일부로 제공하는 동안 /connections 끝점에 대한 POST 요청을 만듭니다.
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.specNamePlatform에 소스를 인증하기 위해 사용하는 인증 유형입니다.
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 요청을 수행하여 파일 및 디렉터리를 탐색할 수 있습니다.
다음 호출을 사용하여 플랫폼으로 가져올 파일의 경로를 찾습니다.
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=jsonPlatform으로 가져올 파일의 파일 유형입니다. 현재 지원되는 파일 형식은
json뿐입니다.{PREVIEW}연결 콘텐츠가 미리 보기를 지원하는지 여부를 정의하는 부울 값.
{SOURCE_PARAMS}Platform으로 가져올 소스 파일의 매개 변수를 정의합니다. {SOURCE_PARAMS}에 대해 허용되는 형식 유형을 검색하려면 전체 문자열을 base64로 인코딩해야 합니다.
SugarCRM Accounts & Contacts이(가) 여러 API를 지원합니다. 활용하고 있는 오브젝트 유형에 따라 다음 중 하나를 전달하십시오.
accounts: 귀사와 관계를 맺고 있는 회사입니다.contacts: 조직이 관계를 설정한 개별 사용자입니다.
SugarCRM Accounts & Contacts은(는) 여러 API를 지원합니다. 보낼 요청을 활용하는 오브젝트 유형에 따라 다음과 같습니다.
요청
계정
SugarCRM 계정 API의 경우 {SOURCE_PARAMS}의 값이 {"object_type":"accounts"}(으)로 전달됩니다. Base64로 인코딩하면 아래와 같이 eyJvYmplY3RfdHlwZSI6ImFjY291bnRzIn0=과(와) 같습니다.
| code language-shell |
|---|
|
연락처
SugarCRM 연락처 API의 경우 {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 계정 API의 경우 object_type 속성 값은 accounts이어야 합니다.
| code language-shell |
|---|
|
연락처
SugarCRM 연락처 API의 경우 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": "8f1fc72a-f562-4a1d-8597-85b5ca1b1cd3",
"etag": "\"ed05f1e1-0000-0200-0000-6368b8710000\""
}
대상 XDM 스키마 만들기 target-schema
소스 데이터를 플랫폼에서 사용하려면 타겟 스키마를 만들어 필요에 따라 소스 데이터를 구조화해야 합니다. 그런 다음 대상 스키마를 사용하여 소스 데이터가 포함된 Platform 데이터 세트를 만듭니다.
스키마 레지스트리 API에 대한 POST 요청을 수행하여 대상 XDM 스키마를 만들 수 있습니다.
대상 XDM 스키마를 만드는 방법에 대한 자세한 단계는 API를 사용하여 스키마 만들기에 대한 자습서를 참조하십시오.
타겟 데이터 세트 만들기 target-dataset
카탈로그 서비스 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": "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": "059c69f7207b4d7e9b48c47e2fd966a6",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
플로우 만들기 flow
SugarCRM Accounts & Contacts에서 플랫폼으로 데이터를 가져오는 마지막 단계는 데이터 흐름을 만드는 것입니다. 이제 다음 필수 값이 준비되었습니다.
데이터 흐름은 소스에서 데이터를 예약하고 수집합니다. 페이로드 내에 이전에 언급된 값을 제공하면서 POST 요청을 수행하여 데이터 흐름을 만들 수 있습니다.
수집을 예약하려면 먼저 시작 시간 값을 에포크 시간(초)으로 설정해야 합니다. 그런 다음 빈도 값을 hour 또는 day 중 하나로 설정해야 합니다. 간격 값은 두 개의 연속 수집 사이의 기간을 지정합니다. 간격 값은 hour 또는 day의 scheduleParams.frequency 선택에 따라 1 또는 24(으)로 설정해야 합니다.
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 규격이 아닌 데이터를 Platform으로 가져올 때 필요합니다.
transformations.name변환에 지정된 이름입니다.
transformations.params.mappingId이전 단계에서 생성된 매핑 ID입니다.
transformations.params.mappingVersion매핑 ID의 해당 버전. 이 값은 기본적으로
0입니다.scheduleParams.startTime이 속성은 데이터 흐름의 수집 예약에 대한 정보를 포함합니다.
scheduleParams.frequency데이터 흐름이 데이터를 수집하는 빈도입니다. 허용되는 값은
hour 또는 day입니다.scheduleParams.interval간격은 두 개의 연속 흐름 실행 사이의 기간을 지정합니다. 간격 값은 0이 아닌 정수여야 합니다. 간격 값은
hour 또는 day의 scheduleParams.frequency 선택에 따라 1 또는 24(으)로 설정해야 합니다.응답
성공한 응답은 새로 만든 데이터 흐름의 ID(id)를 반환합니다. 이 ID를 사용하여 데이터 흐름을 모니터링, 업데이트 또는 삭제할 수 있습니다.
{
"id": "fcd16140-81b4-422a-8f9a-eaa92796c4f4",
"etag": "\"9200a171-0000-0200-0000-6368c1da0000\""
}
부록
다음 섹션에서는 데이터 흐름을 모니터링, 업데이트 및 삭제할 수 있는 단계에 대해 설명합니다.
데이터 흐름 모니터링
데이터 흐름이 만들어지면 데이터 흐름을 통해 수집되는 데이터를 모니터링하여 흐름 실행, 완료 상태 및 오류에 대한 정보를 볼 수 있습니다. 전체 API 예제는 API를 사용하여 소스 데이터 흐름 모니터링에 대한 안내서를 참조하십시오.
데이터 흐름 업데이트
데이터 흐름의 ID를 제공하면서 Flow Service API의 /flows 끝점에 PATCH 요청을 하여 데이터 흐름의 이름, 설명, 실행 일정 및 관련 매핑 세트와 같은 데이터 흐름의 세부 정보를 업데이트합니다. PATCH 요청을 할 때 If-Match 헤더에 데이터 흐름의 고유한 etag을(를) 제공해야 합니다. 전체 API 예제는 API를 사용하여 소스 데이터 흐름 업데이트에 대한 안내서를 참조하십시오.
계정 업데이트
기본 연결 ID를 쿼리 매개 변수로 제공하면서 Flow Service API에 대한 PATCH 요청을 수행하여 소스 계정의 이름, 설명 및 자격 증명을 업데이트합니다. PATCH 요청을 할 때는 If-Match 헤더에 원본 계정의 고유 etag을(를) 제공해야 합니다. 전체 API 예제는 API를 사용하여 소스 계정을 업데이트하는 방법에 대한 안내서를 참조하십시오.
데이터 흐름 삭제
쿼리 매개 변수의 일부로 삭제할 데이터 흐름의 ID를 제공하면서 Flow Service API에 대한 DELETE 요청을 수행하여 데이터 흐름을 삭제하십시오. 전체 API 예제는 API를 사용하여 데이터 흐름 삭제에 대한 안내서를 참조하십시오.
계정 삭제
삭제할 계정의 기본 연결 ID를 제공하는 동안 Flow Service API에 대한 DELETE 요청을 수행하여 계정을 삭제합니다. 전체 API 예제는 API를 사용하여 소스 계정 삭제에 대한 안내서를 참조하십시오.
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089