Flow Service API를 사용하여 SFTP 기본 연결 만들기

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

이 자습서에서는 Flow Service API를 사용하여 SFTP (보안 파일 전송 프로토콜)에 대한 기본 연결을 만드는 단계를 안내합니다.

시작

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

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

SFTP 소스 연결을 사용하여 JSON 개체를 섭취할 때 줄바꿈 또는 캐리지 리턴 발생을 방지하는 것이 좋습니다. 제한 사항을 해결하려면 행당 단일 JSON 개체를 사용하고 후속 파일에 여러 줄을 사용합니다.

다음 섹션에서는 Flow Service API를 사용하여 SFTP 서버에 성공적으로 연결하기 위해 알고 있어야 하는 추가 정보를 제공합니다.

필요한 자격 증명 수집

Flow Service이 SFTP에 연결하려면 다음 연결 속성에 값을 제공해야 합니다.

자격 증명 설명
host SFTP 서버와 연결된 이름 또는 IP 주소입니다.
username SFTP 서버에 액세스할 수 있는 사용자 이름입니다.
password SFTP 서버의 암호입니다.
privateKeyContent Base64로 인코딩된 SSH 개인 키 콘텐츠입니다. OpenSSH 키 유형은 RSA 또는 DSA로 분류해야 합니다.
passPhrase 키 파일 또는 키 컨텐츠가 암호 구문으로 보호되는 경우 개인 키를 해독하기 위한 암호 구문 또는 암호입니다. privateKeyContent이(가) 암호로 보호된 경우 이 매개 변수는 개인 키 컨텐츠의 암호 암호와 함께 값으로 사용해야 합니다.
connectionSpec.id 연결 사양은 기본 및 소스 연결 생성과 관련된 인증 사양이 포함된 소스의 커넥터 등록 정보를 반환합니다. SFTP에 대한 연결 사양 ID는 다음과 같습니다.b7bf2577-4520-42c9-bae9-cad01560f7bc.

플랫폼 API 사용

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

기본 연결 만들기

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

기본 연결 ID를 만들려면 요청 매개 변수의 일부로 SFTP 인증 자격 증명을 제공하는 동안 /connections 끝점에 POST 요청을 하십시오.

기본 인증을 사용하여 SFTP 연결 만들기

기본 인증을 사용하여 SFTP 기본 연결을 만들려면 연결의 host, userNamepassword 값을 제공하는 동안 Flow Service API에 POST 요청을 수행하십시오.

API 형식

POST /connections

요청

다음 요청은 기본 인증을 사용하여 SFTP에 대한 기본 연결을 만듭니다.

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d  '{
        "name": "SFTP connector with password",
        "description": "SFTP connector password",
        "auth": {
            "specName": "Basic Authentication for sftp",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
            "version": "1.0"
        }
    }'
속성 설명
auth.params.host SFTP 서버의 호스트 이름입니다.
auth.params.username SFTP 서버와 연결된 사용자 이름입니다.
auth.params.password SFTP 서버와 연결된 암호입니다.
connectionSpec.id SFTP 서버 연결 사양 ID:b7bf2577-4520-42c9-bae9-cad01560f7bc

응답

성공적으로 응답하면 새로 만든 연결의 고유 식별자(id)가 반환됩니다. 이 ID는 다음 자습서에서 SFTP 서버를 탐색하는 데 필요합니다.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

SSH 공개 키 인증을 사용하여 SFTP 연결을 만듭니다

SSH 공개 키 인증을 사용하여 SFTP 기본 연결을 만들려면 연결의 host, userName, privateKeyContentpassPhrase에 대한 값을 제공하는 동안 Flow Service API에 POST 요청을 수행하십시오.

중요

SFTP 커넥터는 RSA 또는 DSA 유형 OpenSSH 키를 지원합니다. 키 파일 컨텐츠가 "-----BEGIN [RSA/DSA] PRIVATE KEY-----"으로 시작하고 "-----END [RSA/DSA] PRIVATE KEY-----"로 끝나야 합니다. 개인 키 파일이 PPK 형식 파일인 경우 PuTTY 도구를 사용하여 PPK에서 OpenSSH 형식으로 변환합니다.

API 형식

POST /connections

요청

다음 요청은 SSH 공개 키 인증을 사용하여 SFTP에 대한 기본 연결을 만듭니다.

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "SFTP connector with SSH authentication",
        "description": "SFTP connector with SSH authentication",
        "auth": {
            "specName": "SSH PublicKey Authentication for sftp",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "privateKeyContent": "{PRIVATE_KEY_CONTENT}",
                "passPhrase": "{PASSPHRASE}"
            }
        },
        "connectionSpec": {
            "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
            "version": "1.0"
        }
    }'
속성 설명
auth.params.host SFTP 서버의 호스트 이름입니다.
auth.params.username SFTP 서버와 연결된 사용자 이름입니다.
auth.params.privateKeyContent Base64로 인코딩된 SSH 개인 키 콘텐츠입니다. OpenSSH 키 유형은 RSA 또는 DSA로 분류해야 합니다.
auth.params.passPhrase 키 파일 또는 키 컨텐츠가 암호 구문으로 보호되는 경우 개인 키를 해독하기 위한 암호 구문 또는 암호입니다. PrivateKeyContent가 암호로 보호된 경우 이 매개 변수는 PrivateKeyContent의 암호와 함께 값으로 사용해야 합니다.
connectionSpec.id SFTP 서버 연결 사양 ID:b7bf2577-4520-42c9-bae9-cad01560f7bc

응답

성공적으로 응답하면 새로 만든 연결의 고유 식별자(id)가 반환됩니다. 이 ID는 다음 자습서에서 SFTP 서버를 탐색하는 데 필요합니다.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

다음 단계

이 자습서에 따르면 Flow Service API를 사용하여 SFTP 연결을 만들고 연결의 고유 ID 값을 받았습니다. 이 연결 ID를 사용하여 Flow Service API 또는 Flow Service API를 사용하여 Parquet 데이터를 수집하여 클라우드 저장소를 탐색할 수 있습니다.

이 페이지에서는