Show Menu
화제×

Flow Service API를 사용하여 Azure Data Lake Storage Gen2 커넥터 만들기

Flow Service는 Adobe Experience Platform에서 다양한 소스의 고객 데이터를 수집하고 중앙에서 관리하는 데 사용됩니다. 이 서비스는 지원되는 모든 소스가 연결되어 있는 사용자 인터페이스와 RESTful API를 제공합니다.
이 자습서에서는 Flow Service API를 사용하여 경험 플랫폼을 Azure Data Lake Storage Gen2(이하 "ADLS Gen2"라 한다)에 연결하는 단계를 안내합니다.

시작하기

이 가이드는 Adobe Experience Platform의 다음 구성 요소에 대해 작업해야 합니다.
  • 소스 :Adobe Experience Platform을 사용하면 다양한 소스에서 데이터를 인제스트할 수 있을 뿐만 아니라 플랫폼 서비스를 사용하여 들어오는 데이터를 구조화, 레이블 지정 및 향상시킬 수 있습니다.
  • 샌드박스 :Experience Platform은 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 되도록 단일 플랫폼 인스턴스를 별도의 가상 환경으로 분할하는 가상 샌드박스를 제공합니다.
다음 섹션에서는 Flow Service API를 사용하여 ADLS Gen2 소스 커넥터를 성공적으로 만들기 위해 알아야 할 추가 정보를 제공합니다.

필요한 자격 증명 수집

Flow Service가 ADLS Gen2에 연결하려면 다음 연결 속성에 대한 값을 제공해야 합니다.
자격 증명
설명
url
주소 URL.
servicePrincipalId
응용 프로그램의 클라이언트 ID입니다.
servicePrincipalKey
응용 프로그램 키
tenant
응용 프로그램이 포함된 테넌트 정보.
이러한 값에 대한 자세한 내용은 이 ADLS Gen2 문서를 참조하십시오.

샘플 API 호출 읽기

이 자습서에서는 요청의 서식을 지정하는 방법을 보여주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 올바른 형식의 요청 페이로드가 포함됩니다. API 응답에서 반환되는 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 Experience Platform 문제 해결 안내서에서 API 호출 예를 읽는 방법에 대한 섹션을 참조하십시오.

필수 헤더에 대한 값 수집

플랫폼 API를 호출하려면 먼저 인증 자습서를 완료해야 합니다. 인증 튜토리얼을 완료하면 다음과 같이 모든 Experience Platform API 호출에서 각 필수 헤더에 대한 값이 제공됩니다.
  • 인증:베어러 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Flow Service에 속하는 리소스를 비롯하여 Experience Platform의 모든 리소스는 특정 가상 샌드박스로 분리됩니다. 플랫폼 API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다.
  • x-sandbox-name: {SANDBOX_NAME}
페이로드(POST, PUT, PATCH)가 포함된 모든 요청에는 추가 미디어 유형 헤더가 필요합니다.
  • 컨텐츠 유형: application/json

연결 사양 조회

플랫폼을 ADLS Gen2에 연결하기 전에 ADLS Gen2에 대한 연결 사양이 있는지 확인해야 합니다. 연결 사양이 없으면 연결할 수 없습니다.
사용 가능한 각 소스에는 인증 요구 사항과 같은 커넥터 속성을 설명하는 고유한 연결 사양 세트가 있습니다. GET 요청을 수행하고 쿼리 매개 변수를 사용하여 ADLS Gen2의 연결 사양을 조회할 수 있습니다.
API 형식
쿼리 매개 변수 없이 GET 요청을 전송하면 사용 가능한 모든 소스에 대한 연결 사양이 반환됩니다. 쿼리를 포함하여 ADLS Gen2에 대한 정보를 property=name=="adls-gen2" 얻을 수 있습니다.
GET /connectionSpecs
GET /connectionSpecs?property=name=="adls-gen2"

요청
다음 요청은 ADLS Gen2의 연결 사양을 검색합니다.
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="adls-gen2"' \
    -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}'

응답
성공적인 응답은 ADLS Gen2의 고유 식별자( id )를 포함하여 연결 사양을 반환합니다. 이 ID는 기본 연결을 만들려면 다음 단계에서 필요합니다.
{
    "items": [
        {
            "id": "b3ba5556-48be-44b7-8b85-ff2b69b46dc4",
            "name": "adls-gen2",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication for adls-gen2",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to adlsgen2 using service principal",
                        "properties": {
                            "url": {
                                "type": "string",
                                "description": "Endpoint for Azure Data Lake Storage Gen2."
                            },
                            "servicePrincipalId": {
                                "type": "string",
                                "description": "Service Principal Id to connect to ADLSGen2."
                            },
                            "servicePrincipalKey": {
                                "type": "string",
                                "description": "Service Principal Key to connect to ADLSGen2.",
                                "format": "password"
                            },
                            "tenant": {
                                "type": "string",
                                "description": "Tenant information(domain name or tenant ID)."
                            }
                        },
                        "required": [
                            "url",
                            "servicePrincipalId",
                            "servicePrincipalKey",
                            "tenant"
                        ]
                    }
                }
            ]
        }
    ]
}

기본 연결 만들기

기본 연결은 소스를 지정하고 해당 소스에 대한 자격 증명을 포함합니다. 여러 소스 커넥터를 만들어 다른 데이터를 가져오는 데 사용할 수 있으므로 ADLS Gen2 계정당 하나의 기본 연결만 필요합니다.
API 형식
POST /connections

요청
curl -X POST \
    'http://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": "adls-gen2",
        "description": "base connection for adls-gen2",
        "auth": {
            "specName": "Basic Authentication for adls-gen2",
            "params": {
                "url": "{URL}",
                "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
                "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}",
                "tenant": "{TENANT}"
            }
        },
        "connectionSpec": {
            "id": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0"
        }
    }'

속성
설명
auth.params.url
ADLS Gen2 계정의 URL 끝점입니다.
auth.params.servicePrincipalId
ADLS Gen2 계정의 서비스 주체 ID.
auth.params.servicePrincipalKey
ADLS Gen2 계정의 서비스 주요 키입니다.
auth.params.tenant
ADLS Gen2 계정의 테넌트 정보.
connectionSpec.id
이전 단계에서 검색되는 ADLS Gen2 id 계정의 연결 사양입니다.
응답
성공적인 응답은 고유 식별자( id )를 포함하여 새로 만든 기본 연결의 세부 정보를 반환합니다. 다음 단계에서 클라우드 스토리지를 살펴보려면 이 ID가 필요합니다.
{
    "id": "7497ad71-6d32-4973-97ad-716d32797304",
    "etag": "\"23005f80-0000-0200-0000-5e1d00a20000\""
}

다음 단계

이 자습서를 따라 API를 사용하여 ADLS Gen2 연결을 만들고 응답 본문의 일부로 고유 ID를 받았습니다. 이 연결 ID를 사용하여 Flow Service API를 사용하여 클라우드 스토리지를 탐색하거나 Flow Service API를 사용하여 인제스트 쪽모이 세공 데이터를 생성할 수 있습니다.