흐름 서비스 API를 사용하여 계정 업데이트

경우에 따라 기존 기본 연결의 세부 정보를 업데이트해야 할 수도 있습니다. Flow Service은(는) 이름, 설명 및 자격 증명을 포함하여 기존 일괄 처리 또는 스트리밍 연결의 세부 정보를 추가, 편집 및 삭제할 수 있는 기능을 제공합니다.

이 자습서에서는 Flow Service API를 사용하여 연결의 세부 정보 및 자격 증명을 업데이트하는 단계를 다룹니다.

TIP
업데이트가 필요한 경우에는 새 기본 연결을 만들 필요가 없습니다. 기본 연결에 대한 모든 변경 사항은 관련 데이터 흐름에 반영됩니다.

시작하기

이 자습서에서는 기존 연결 및 유효한 연결 ID가 있어야 합니다. 기존 연결이 없는 경우 소스 개요에서 선택한 소스를 선택하고 이 자습서를 시도하기 전에 설명된 단계를 따르십시오.

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

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

Experience Platform API 사용

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

연결 세부 정보 조회

연결을 업데이트하는 첫 번째 단계는 연결 ID를 사용하여 세부 사항을 검색하는 것입니다. 연결의 현재 세부 정보를 검색하려면 업데이트할 연결의 연결 ID를 제공하는 동안 Flow Service API에 GET 요청을 만듭니다.

API 형식

GET /connections/{CONNECTION_ID}
매개변수
설명
{CONNECTION_ID}
검색할 연결에 대한 고유한 id 값입니다.

요청

다음 요청은 연결 관련 정보를 검색합니다.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/139f6a5f-a78b-4744-9f6a-5fa78bd74431' \
    -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}'

응답

성공한 응답은 자격 증명, 고유 식별자(id) 및 버전을 포함하여 현재 연결 세부 정보를 반환합니다. 연결을 업데이트하려면 버전 값이 필요합니다.

{
    "items": [
        {
            "createdAt": 1597973312000,
            "updatedAt": 1597973312000,
            "createdBy": "{CREATED_BY}",
            "updatedBy": "{UPDATED_BY}",
            "createdClient": "{CREATED_CLIENT}",
            "updatedClient": "{UPDATED_CLIENT}",
            "sandboxName": "{SANDBOX_NAME}",
            "id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
            "name": "E2E_SF Base_Connection",
            "connectionSpec": {
                "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
                "version": "1.0"
            },
            "state": "enabled",
            "auth": {
                "specName": "Basic Authentication",
                "params": {
                    "securityToken": "{SECURITY_TOKEN}",
                    "password": "{PASSWORD}",
                    "username": "my-salesforce-account",
                    "environmentUrl": "login.salesforce.com"
                }
            },
            "version": "\"1400dd53-0000-0200-0000-5f3f23450000\"",
            "etag": "\"1400dd53-0000-0200-0000-5f3f23450000\""
        }
    ]
}

연결 업데이트

연결의 이름, 설명 및 자격 증명을 업데이트하려면 연결 ID, 버전 및 사용할 새 정보를 제공하는 동안 Flow Service API에 대한 PATCH 요청을 수행합니다.

IMPORTANT
PATCH 요청을 수행할 때 If-Match 헤더가 필요합니다. 이 헤더의 값은 업데이트할 연결의 고유한 버전입니다.

API 형식

PATCH /connections/{CONNECTION_ID}
매개변수
설명
{CONNECTION_ID}
업데이트할 연결에 대한 고유한 id 값입니다.

요청

다음 요청은 연결을 업데이트할 새 자격 증명 집합과 새 이름 및 설명을 제공합니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/connections/139f6a5f-a78b-4744-9f6a-5fa78bd74431' \
    -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 'If-Match: 1400dd53-0000-0200-0000-5f3f23450000' \
    -d '[
        {
            "op": "replace",
            "path": "/auth/params",
            "value": {
                "username": "salesforce-connector-username",
                "password": "{NEW_PASSWORD}",
                "securityToken": "{NEW_SECURITY_TOKEN}"
            }
        },
        {
            "op": "replace",
            "path": "/name",
            "value": "Test salesforce connection"
        },
        {
            "op": "add",
            "path": "/description",
            "value": "A test salesforce connection"
        }
    ]'
매개변수
설명
op
연결을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업에는 add, replaceremove이(가) 포함됩니다.
path
업데이트할 매개 변수의 경로입니다.
value
매개 변수를 업데이트할 새 값입니다.

응답

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

{
    "id": "139f6a5f-a78b-4744-9f6a-5fa78bd74431",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}

다음 단계

이 자습서에 따라 Flow Service API를 사용하는 연결과 관련된 자격 증명 및 정보를 업데이트했습니다. 소스 커넥터 사용에 대한 자세한 내용은 소스 개요를 참조하십시오.

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