만들기 Amazon 를 사용한 S3 기본 연결 Flow Service API

기본 연결은 소스와 Adobe Experience Platform 간의 인증된 연결을 나타냅니다.

이 자습서에서는 다음에 대한 기본 연결을 만드는 단계를 안내합니다 Amazon S3 (이하 "라 한다) S3") Flow Service API.

시작하기

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

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

다음 섹션에서는 다음에 성공적으로 연결하기 위해 알고 있어야 하는 추가 정보를 제공합니다 S3 스토리지 Flow Service API.

필요한 자격 증명 수집

대상 Flow Service 와 연결 S3 저장 영역에서는 다음 연결 속성에 대한 값을 제공해야 합니다.

자격 증명 설명
s3AccessKey 사용자의 액세스 키 ID입니다 S3 버킷.
s3SecretKey 사용자의 암호 키 ID S3 버킷.
serviceUrl (선택 사항) 사용자 지정 S3 연결할 끝점입니다. 이 필드는 S3 버킷은 영역별로 다릅니다. 의 형식 serviceUrl is: https://s3.{REGION}.amazonaws.com/).
bucketName 다음 S3 버킷에는 데이터와 해당 설명 메타데이터가 포함되어 있습니다. 사용자 S3 버킷 이름은 3자에서 63자 사이여야 하며 문자 또는 숫자로 시작하고 끝나야 합니다. 버킷 이름은 소문자, 숫자 또는 하이픈(-)이고 IP 주소로 형식을 지정할 수 없습니다.
folderPath 폴더의 경로 S3 데이터가 저장되는 버킷. 이 자격 증명은 사용자가 액세스를 제한한 경우에 필요합니다.
s3SessionToken (선택 사항) 임시 액세스를 제공할 수 있는 단기 임시 토큰입니다 S3 신뢰할 수 없는 환경의 사용자에게 리소스를 제공합니다. 자세한 내용은 S3 개요 추가 정보.
connectionSpec.id 연결 사양은 기본 및 소스 연결 생성과 관련된 인증 사양이 포함된 소스의 커넥터 등록 정보를 반환합니다. 에 대한 연결 사양 ID S3 is: ecadc60c-7455-4d87-84dc-2a0e293d997b.

시작하는 방법에 대한 자세한 내용은 이 Amazon Web Services 문서.

플랫폼 API 사용

Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 플랫폼 API 시작.

기본 연결 만들기

기본 연결은 소스의 인증 자격 증명, 현재 연결 상태 및 고유한 기본 연결 ID를 포함하여 소스와 플랫폼 간의 정보를 유지합니다. 기본 연결 ID를 사용하면 소스 내에서 파일을 탐색 및 탐색하고 해당 데이터 유형 및 형식에 대한 정보를 포함하여 수집할 특정 항목을 식별할 수 있습니다.

기본 연결 ID를 만들려면 /connections 제공하는 동안 엔드포인트 S3 요청 매개 변수의 일부로 인증 자격 증명.

API 형식

POST /connections

요청

다음 요청은에 대한 기본 연결을 만듭니다. S3:

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": "Amazon S3 base connection",
        "description": "Amazon S3 base connection with temporary session token",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}",
                "s3SessionToken": "{S3_SESSION_TOKEN}
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'
속성 설명
auth.params.s3AccessKey 와 연결된 액세스 키 S3 버킷.
auth.params.s3SecretKey 사용자의 S3 버킷.
auth.params.s3SessionToken (선택 사항) 단기, 임시 S3 버킷에 액세스하는 데 사용되는 토큰입니다.
connectionSpec.id 다음 S3 연결 사양 ID: ecadc60c-7455-4d87-84dc-2a0e293d997b

응답

성공적인 응답은 고유 식별자( )를 포함하여 새로 생성된 연결의 세부 정보를 반환합니다id). 이 ID는 다음 자습서에서 저장소를 탐색하는 데 필요합니다.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

다음 단계

이 자습서에 따르면 API를 사용하여 S3 연결을 만들고 고유한 ID를 응답 본문의 일부로 받았습니다. 이 연결 ID를 사용하여 다음을 수행할 수 있습니다 흐름 서비스 API를 사용하여 클라우드 스토리지 살펴보기.

부록

다음 섹션에서는 S3 소스.

업데이트 S3 세션 토큰

다음 s3SessionToken 는 일시적이며 만료되면 업데이트해야 합니다. PATCH 요청을에 수행하여 기본 연결과 연결된 세션 토큰을 업데이트할 수 있습니다 Flow Service API. 자세한 내용은 S3 개요 을 위한 임시 보안 자격 증명에 대한 자세한 정보 S3.

중요

다음 If-Match PATCH 요청을 만들 때는 헤더가 필요합니다. 이 헤더의 값은 업데이트할 연결의 고유한 문자열입니다.

API 형식

PATCH /connections

요청

다음 요청은에 대한 기본 연결을 만듭니다. S3:

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
    -d '[
        {
            "op": "replace",
            "path": "/auth/params/s3SessionToken",
            "value": "{SESSION_TOKEN}"
        }
    ]'
매개 변수 설명
op 연결을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업은 다음과 같습니다. add, replace, 및 remove.
path 업데이트할 매개 변수의 경로입니다.
value 매개 변수를 업데이트할 새 값입니다.

응답

성공적인 응답은 기본 연결 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service API, 연결 ID를 제공하는 동안

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

이 페이지에서는