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

Last update: Wed May 24 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:
Sources

작성 대상:

Developer

기본 연결은 소스와 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 은(는) https://s3.{REGION}.amazonaws.com/).

bucketName

다음 S3 버킷에는 데이터 및 해당 설명 메타데이터가 포함됩니다. 사용자 S3 버킷 이름은 3자에서 63자 사이여야 하며 문자 또는 숫자로 시작하고 끝나야 합니다. 버킷 이름에는 소문자, 숫자 또는 하이픈(-), IP 주소 형식을 지정할 수 없습니다.

folderPath

폴더에 대한 경로 S3 데이터가 저장되는 버킷입니다. 이 자격 증명은 사용자가 액세스를 제한한 경우에 필요합니다.

s3SessionToken

(선택 사항) 에 대한 임시 액세스를 제공할 수 있는 단기 임시 토큰 S3 신뢰할 수 없는 환경의 사용자에게 리소스를 제공합니다. 다음을 참조하십시오. S3 개요 추가 정보.

connectionSpec.id

연결 사양은 기본 및 소스 연결 만들기와 관련된 인증 사양을 포함하여 소스의 커넥터 속성을 반환합니다. 에 대한 연결 사양 ID S3 은(는) ecadc60c-7455-4d87-84dc-2a0e293d997b.

시작하기에 대한 자세한 내용은 다음을 참조하십시오. 이 Amazon Web Services 문서.

Platform API 사용

Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 의 안내서를 참조하십시오. platform API 시작하기.

기본 연결 만들기

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

POST 기본 연결 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.

IMPORTANT

다음 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와 업데이트된 etag를 반환합니다. 에 GET 요청을 하여 업데이트를 확인할 수 있습니다. Flow Service API, 연결 ID 제공

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

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089