를 사용하여 데이터베이스 탐색 Flow Service API

이 자습서에서는 Flow Service 타사 데이터베이스의 콘텐츠 및 파일 구조를 탐색하기 위한 API입니다.

시작하기

이 안내서에서는 Adobe Experience Platform의 다음 구성 요소를 이해하고 있어야 합니다.

  • 소스: Experience Platform 을(를) 사용하여 들어오는 데이터를 구조화, 레이블 지정 및 향상시키는 기능을 제공하면서 다양한 소스에서 데이터를 수집할 수 있습니다. Platform 서비스.
  • 샌드박스: Experience Platform 단일 파티션을 생성하는 가상 샌드박스 제공 Platform 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 되는 별도의 가상 환경으로 인스턴스를 구축할 수 있습니다.

다음 섹션에서는 를 사용하여 타사 데이터베이스에 성공적으로 연결하기 위해 알아야 하는 추가 정보를 제공합니다 Flow Service API.

필요한 자격 증명 수집

이 자습서에서는 데이터를 수집할 타사 데이터베이스와 유효한 연결이 있어야 합니다. 올바른 연결에는 데이터베이스의 연결 사양 ID 및 연결 ID가 포함됩니다. 데이터베이스 연결을 만들고 이러한 값을 검색하는 방법에 대한 자세한 내용은 소스 커넥터 개요.

샘플 API 호출 읽기

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

필수 헤더에 대한 값을 수집합니다

을 호출하려면 Platform API를 먼저 완료해야 합니다. 인증 자습서. 인증 자습서를 완료하면 모든 E에서 각 필수 헤더에 대한 값을 제공합니다xperience Platform 아래에 표시된 대로 API 호출:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

의 모든 리소스 Experience Platform에 속했던 것 포함 Flow Service은 특정 가상 샌드박스로 구분됩니다. 에 대한 모든 요청 Platform API에는 작업이 발생할 샌드박스의 이름을 지정하는 헤더가 필요합니다.

  • x-sandbox-name: {SANDBOX_NAME}

페이로드(POST, PUT, PATCH)이 포함된 모든 요청에는 추가 미디어 유형 헤더가 필요합니다.

  • Content-Type: application/json

데이터 테이블 탐색

데이터베이스에 대한 연결 ID를 사용하여 GET 요청을 수행하여 데이터 테이블을 탐색할 수 있습니다. 다음 호출을 사용하여 검사하거나 수집할 테이블의 경로를 찾습니다 Platform.

API 형식

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
매개 변수 설명
{BASE_CONNECTION_ID} 데이터베이스 소스의 연결 ID입니다.

요청

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=root' \
    -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}'

응답

성공적인 응답은 데이터베이스에서 테이블 배열을 반환합니다. 가져올 테이블을 찾으십시오 Platform 그리고 그것을 주목하세요 path 속성을 확인하기 위해 다음 단계에서 제공해야 하므로 속성을 검사합니다.

[
    {
        "type": "table",
        "name": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect 테이블 구조

데이터베이스에서 테이블의 구조를 검사하려면 테이블의 경로를 쿼리 매개 변수로 지정하는 동안 GET 요청을 수행합니다.

API 형식

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
매개 변수 설명
{BASE_CONNECTION_ID} 데이터베이스 연결의 ID입니다.
{TABLE_PATH} 표의 경로입니다.

요청

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -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}'

응답

성공적인 응답은 지정된 테이블의 구조를 반환합니다. 각 테이블의 열에 대한 세부 사항은 columns 배열입니다.

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

다음 단계

이 자습서에 따라 데이터베이스를 탐색하여 수집할 테이블의 경로를 찾았습니다 Platform, 및에서 해당 구조에 대한 정보를 얻습니다. 이 정보는 다음 자습서에서 사용할 수 있습니다 데이터베이스에서 데이터를 수집하여 플랫폼으로 가져오기.

이 페이지에서는