[Beta]{class="badge informative"}
흐름 서비스 API를 사용하여 Chatlio에 대한 소스 연결 및 데이터 흐름을 만듭니다.
다음 자습서에서는 Flow Service API를 사용하여 Chatlio 이벤트 데이터를 Adobe Experience Platform으로 가져오기 위한 소스 연결 및 데이터 흐름을 만드는 단계를 안내합니다.
시작하기 getting-started
이 안내서를 사용하려면 다음 Experience Platform 구성 요소에 대해 이해하고 있어야 합니다.
Flow Service API를 사용하여 Chatlio을(를) 플랫폼에 연결 connect-platform-to-flow-api
다음은 소스 연결 및 데이터 흐름을 만들어 Chatlio 이벤트 데이터를 Experience Platform 상태로 만들기 위해 수행해야 하는 단계를 간략하게 설명합니다.
소스 연결 만들기 source-connection
소스의 연결 사양 ID, 이름 및 설명 등 세부 정보 및 데이터 형식을 제공하면서 Flow Service API에 대한 POST 요청을 수행하여 소스 연결을 만드십시오.
API 형식
POST /sourceConnections
요청
다음 요청은 Chatlio에 대한 소스 연결을 만듭니다.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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": "Streaming Source Connection for Chatlio.",
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"description": "Streaming Source Connection for Chatlio.",
"connectionSpec": {
"id": "073127a3-26e3-496c-9d94-9f48fb93fba8",
"version": "1.0"
},
"data": {
"format": "json"
}
}'
name
description
connectionSpec.id
data.format
json
뿐입니다.응답
성공한 응답은 새로 만든 원본 연결의 고유 식별자(id
)를 반환합니다. 이 ID는 데이터 흐름을 만들기 위해 이후 단계에서 필요합니다.
{
"id": "7689a40d-43eb-4f74-a3f1-092a55884f6c",
"etag": "\"01013ed0-0000-0200-0000-63f314d00000\""
}
대상 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
요청
다음 요청은 Chatlio에 대한 대상 연결을 만듭니다.
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": "Streaming Target Connection for a Chatlio.",
"description": "Streaming Target Connection for a Chatlio.",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "json",
"schema": {
"id": "https://ns.adobe.com/extconndev/schemas/49cecec83dd1a8da1aef4a96c67c06654e8c337a0a3b4262",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "63ef7df781f14a1bd02a7e49"
}
}'
name
description
connectionSpec.id
c604ff05-7f1a-43c0-8e18-33bf874cb11c
입니다.data.format
params.dataSetId
응답
응답이 성공하면 새 대상 연결의 고유 식별자(id
)가 반환됩니다. 이 ID는 이후 단계에서 필수입니다.
{
"id": "f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5",
"etag": "\"7f0072bc-0000-0200-0000-63f314a50000\""
}
매핑 만들기 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/945546112b746524bfd9f1264b26c2b7d8e7f5b7fadb953a",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"destinationXdmPath": "_extconndev.slackchannel_ID",
"sourceAttribute": "slackChannelId",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.slackchannel_name",
"sourceAttribute": "slackChannelName",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.UUID",
"sourceAttribute": "visitor.UUID",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.chatlio_email",
"sourceAttribute": "visitor.email",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.message",
"sourceAttribute": "message",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.channel_ID",
"sourceAttribute": "channelId",
"identity": false,
"version": 0
}
]
}'
outputSchema.schemaRef.id
mappings.sourceType
mappings.source
mappings.destination
응답
성공한 응답은 고유 식별자(id
)를 포함하여 새로 만든 매핑의 세부 정보를 반환합니다. 이 값은 데이터 흐름을 만들기 위해 이후 단계에서 필요합니다.
{
"id": "4b7188aad69c44529a5e674ab5d3568b",
"version": 0,
"createdDate": 1676875099546,
"modifiedDate": 1676875099546,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
플로우 만들기 flow
Chatlio에서 플랫폼으로 데이터를 가져오는 마지막 단계는 데이터 흐름을 만드는 것입니다. 이제 다음 필수 값이 준비되었습니다.
데이터 흐름은 소스에서 데이터를 예약하고 수집합니다. 페이로드 내에 이전에 언급된 값을 제공하면서 POST 요청을 수행하여 데이터 흐름을 만들 수 있습니다.
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": "Streaming Dataflow for Chatlio",
"description": "Streaming Dataflow for Chatlio",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"sourceConnectionIds": [
"7689a40d-43eb-4f74-a3f1-092a55884f6c"
],
"targetConnectionIds": [
"f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "4b7188aad69c44529a5e674ab5d3568b",
"mappingVersion": 0
}
}
]
}'
name
description
flowSpec.id
e77fde5a-22a8-11ed-861d-0242ac120002
입니다.flowSpec.version
1.0
입니다.sourceConnectionIds
targetConnectionIds
transformations
transformations.name
transformations.params.mappingId
transformations.params.mappingVersion
0
입니다.응답
성공한 응답은 새로 만든 데이터 흐름의 ID(id
)를 반환합니다. 이 ID를 사용하여 데이터 흐름을 모니터링, 업데이트 또는 삭제할 수 있습니다.
{
"id": "d947e6a9-ea53-42c4-985c-c9379265491f",
"etag": "\"9b01c840-0000-0200-0000-63f3163e0000\""
}
스트리밍 끝점 URL 가져오기 get-streaming-endpoint
데이터 흐름이 만들어지면 이제 스트리밍 끝점 URL을 검색할 수 있습니다. 이 끝점 URL을 사용하여 소스를 웹후크에 구독하므로 소스가 Experience Platform과 통신할 수 있습니다.
스트리밍 끝점 URL을 검색하려면 /flows
끝점에 대한 GET 요청을 만들고 데이터 흐름의 ID를 제공하십시오.
API 형식
GET /flows/{FLOW_ID}
요청
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/flows/4982698b-e6b3-48c2-8dcf-040e20121fd2' \
-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}'
응답
응답이 inletUrl
(으)로 표시된 엔드포인트 URL을 포함하여 데이터 흐름에 대한 정보를 반환합니다. Webhook 설정 페이지를 참조하여 필요한 값을 얻으십시오.
{
"items": [
{
"id": "d947e6a9-ea53-42c4-985c-c9379265491f",
"createdAt": 1676875325841,
"updatedAt": 1676875331938,
"createdBy": "acme@AdobeID",
"updatedBy": "acme@AdobeID",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "Streaming Dataflow for Chatlio",
"description": "Streaming Dataflow for Chatlio",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"state": "enabled",
"version": "\"9b012541-0000-0200-0000-63f316430000\"",
"etag": "\"9b012541-0000-0200-0000-63f316430000\"",
"sourceConnectionIds": [
"7689a40d-43eb-4f74-a3f1-092a55884f6c"
],
"targetConnectionIds": [
"f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5"
],
"inheritedAttributes": {
"properties": {
"isSourceFlow": true
},
"sourceConnections": [
{
"id": "7689a40d-43eb-4f74-a3f1-092a55884f6c",
"connectionSpec": {
"id": "073127a3-26e3-496c-9d94-9f48fb93fba8",
"version": "1.0"
}
}
],
"targetConnections": [
{
"id": "f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"options": {
"inletUrl": "https://dcs.adobedc.net/collection/e71b6a6cd7270388674f8ab68ee438da58ba4434dea63cc547ee21547275923c"
},
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "4b7188aad69c44529a5e674ab5d3568b",
"mappingVersion": 0
}
}
],
"runs": "/runs?property=flowId==d947e6a9-ea53-42c4-985c-c9379265491f",
"providerRefId": "bfac26f5-9256-438c-b1a0-e07a7dc675f6",
"lastOperation": {
"started": 0,
"updated": 0,
"operation": "enable"
}
}
]
}
부록 appendix
다음 섹션에서는 데이터 흐름을 모니터링, 업데이트 및 삭제할 수 있는 단계에 대해 설명합니다.
데이터 흐름 모니터링 monitor-dataflow
데이터 흐름이 만들어지면 데이터 흐름을 통해 수집되는 데이터를 모니터링하여 흐름 실행, 완료 상태 및 오류에 대한 정보를 볼 수 있습니다. 전체 API 예제는 API를 사용하여 소스 데이터 흐름 모니터링에 대한 안내서를 참조하십시오.
데이터 흐름 업데이트 update-dataflow
데이터 흐름의 ID를 제공하면서 Flow Service API의 /flows
끝점에 PATCH 요청을 하여 데이터 흐름의 이름, 설명, 실행 일정 및 관련 매핑 세트와 같은 데이터 흐름의 세부 정보를 업데이트합니다. PATCH 요청을 할 때 If-Match
헤더에 데이터 흐름의 고유한 etag
을(를) 제공해야 합니다. 전체 API 예제는 API를 사용하여 소스 데이터 흐름 업데이트에 대한 안내서를 참조하십시오.
계정 업데이트 update-account
기본 연결 ID를 쿼리 매개 변수로 제공하면서 Flow Service API에 대한 PATCH 요청을 수행하여 소스 계정의 이름, 설명 및 자격 증명을 업데이트합니다. PATCH 요청을 할 때는 If-Match
헤더에 원본 계정의 고유 etag
을(를) 제공해야 합니다. 전체 API 예제는 API를 사용하여 소스 계정을 업데이트하는 방법에 대한 안내서를 참조하십시오.
데이터 흐름 삭제 delete-dataflow
쿼리 매개 변수의 일부로 삭제할 데이터 흐름의 ID를 제공하면서 Flow Service API에 대한 DELETE 요청을 수행하여 데이터 흐름을 삭제하십시오. 전체 API 예제는 API를 사용하여 데이터 흐름 삭제에 대한 안내서를 참조하십시오.
계정 삭제 delete-account
삭제할 계정의 기본 연결 ID를 제공하는 동안 Flow Service API에 대한 DELETE 요청을 수행하여 계정을 삭제합니다. 전체 API 예제는 API를 사용하여 소스 계정 삭제에 대한 안내서를 참조하십시오.