설명서Experience Platform소스 커넥터 안내서

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

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 주제:

작성 대상:

  • 개발자

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

이 자습서에서는 Flow Service API를 사용하여 SFTP (Secure File Transfer Protocol)에 대한 기본 연결을 만드는 단계를 안내합니다.

시작하기

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

  • 소스: Experience Platform을 사용하면 플랫폼 서비스를 사용하여 들어오는 데이터를 구조화하고 레이블을 지정하고 개선하는 기능을 제공하는 동시에 다양한 소스에서 데이터를 수집할 수 있습니다.
  • 샌드박스: Experience Platform은 단일 플랫폼 인스턴스를 별도의 가상 환경으로 분할하여 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 되는 가상 샌드박스를 제공합니다.
IMPORTANT
SFTP 소스 연결을 사용하여 JSON 개체를 수집할 때 줄바꿈 또는 캐리지 리턴을 피하는 것이 좋습니다. 제한을 해결하려면 라인당 단일 JSON 개체를 사용하고 후속 파일에 여러 라인을 사용합니다.

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

필요한 자격 증명 수집

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

자격 증명
설명
host
SFTP 서버와 연결된 이름 또는 IP 주소입니다.
port
연결 중인 SFTP 서버 포트입니다. 지정하지 않으면 기본값은 22입니다.
username
SFTP 서버에 액세스할 수 있는 사용자 이름입니다.
password
SFTP 서버의 암호입니다.
privateKeyContent
Base64로 인코딩된 SSH 개인 키 콘텐츠입니다. OpenSSH 키 유형은 RSA 또는 DSA로 분류되어야 합니다.
passPhrase
키 파일 또는 키 콘텐츠가 암호로 보호되어 있는 경우 개인 키를 해독하기 위한 암호나 암호입니다. privateKeyContent이(가) 암호로 보호된 경우 이 매개 변수는 개인 키 콘텐츠의 암호와 함께 값으로 사용해야 합니다.
maxConcurrentConnections
이 매개 변수를 사용하면 SFTP 서버에 연결할 때 플랫폼이 생성하는 동시 연결 수에 대한 최대 제한을 지정할 수 있습니다. 이 값을 SFTP에서 설정한 제한보다 작게 설정해야 합니다. 참고: 기존 SFTP 계정에 대해 이 설정을 사용하면 향후 데이터 흐름에만 영향을 주고 기존 데이터 흐름에는 영향을 주지 않습니다.
folderPath
액세스 권한을 제공할 폴더의 경로입니다. SFTP 원본, 폴더 경로를 제공하여 선택한 하위 폴더에 대한 사용자 액세스를 지정할 수 있습니다.
connectionSpec.id
연결 사양은 기본 및 소스 연결 만들기와 관련된 인증 사양을 포함하여 소스의 커넥터 속성을 반환합니다. SFTP의 연결 사양 ID는 b7bf2577-4520-42c9-bae9-cad01560f7bc입니다.

Platform API 사용

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

기본 연결 만들기

TIP
만든 후에는 SFTP 기본 연결의 인증 유형을 변경할 수 없습니다. 인증 유형을 변경하려면 새 기본 연결을 만들어야 합니다.

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

SFTP 원본은 기본 인증과 SSH 공개 키를 통한 인증을 모두 지원합니다. 이 단계에서 액세스 권한을 제공할 하위 폴더의 경로를 지정할 수도 있습니다.

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

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

API 형식

POST /connections
기본 인증
accordion
요청
code language-shell 
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": "SFTP connector with password",
      "description": "SFTP connector password",
      "auth": {
          "specName": "Basic Authentication for sftp",
          "params": {
              "host": "{HOST}",
              "port": 22,
              "userName": "{USERNAME}",
              "password": "{PASSWORD}",
              "maxConcurrentConnections": 5,
              "folderPath": "acme/business/customers/holidaySales"
          }
      },
      "connectionSpec": {
          "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2
속성 설명
auth.params.host SFTP 서버의 호스트 이름입니다.
auth.params.port SFTP 서버의 포트입니다. 이 정수 값은 기본적으로 22입니다.
auth.params.username SFTP 서버와 연결된 사용자 이름입니다.
auth.params.password SFTP 서버와 연결된 암호입니다.
auth.params.maxConcurrentConnections 플랫폼을 SFTP에 연결할 때 지정된 최대 동시 연결 수입니다. 활성화된 경우 이 값을 1 이상으로 설정해야 합니다.
auth.params.folderPath 액세스 권한을 제공할 폴더의 경로입니다.
connectionSpec.id SFTP 서버 연결 사양 ID: b7bf2577-4520-42c9-bae9-cad01560f7bc
accordion
응답

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

code language-json 
{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
SSH 공개 키 인증
accordion
요청
code language-shell 
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": "SFTP connector with SSH authentication",
      "description": "SFTP connector with SSH authentication",
      "auth": {
          "specName": "SSH PublicKey Authentication for sftp",
          "params": {
              "host": "{HOST}",
              "port": 22,
              "userName": "{USERNAME}",
              "privateKeyContent": "{PRIVATE_KEY_CONTENT}",
              "passPhrase": "{PASSPHRASE}",
              "maxConcurrentConnections": 5,
              "folderPath": "acme/business/customers/holidaySales"
          }
      },
      "connectionSpec": {
          "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2
속성 설명
auth.params.host SFTP 서버의 호스트 이름입니다.
auth.params.port SFTP 서버의 포트입니다. 이 정수 값은 기본적으로 22입니다.
auth.params.username SFTP 서버와 연결된 사용자 이름입니다.
auth.params.privateKeyContent Base64로 인코딩된 SSH 개인 키 콘텐츠입니다. OpenSSH 키 유형은 RSA 또는 DSA로 분류되어야 합니다.
auth.params.passPhrase 키 파일 또는 키 콘텐츠가 암호로 보호되어 있는 경우 개인 키를 해독하기 위한 암호나 암호입니다. PrivateKeyContent가 암호로 보호된 경우 이 매개 변수는 PrivateKeyContent의 암호와 함께 값으로 사용해야 합니다.
auth.params.maxConcurrentConnections 플랫폼을 SFTP에 연결할 때 지정된 최대 동시 연결 수입니다. 활성화된 경우 이 값을 1 이상으로 설정해야 합니다.
auth.params.folderPath 액세스 권한을 제공할 폴더의 경로입니다.
connectionSpec.id SFTP 서버 연결 사양 ID: b7bf2577-4520-42c9-bae9-cad01560f7bc
accordion
응답

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

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

다음 단계

이 자습서에 따라 Flow Service API를 사용하여 SFTP 연결을 만들고 연결의 고유 ID 값을 얻었습니다. 이 연결 ID를 사용하여 흐름 서비스 API를 사용하여 클라우드 저장소 탐색할 수 있습니다.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089