Flow Service API를 사용하여 Square 기본 연결 만들기
작성 대상:
- 개발자
기본 연결은 소스와 Adobe Experience Platform 간의 인증된 연결을 나타냅니다.
이 자습서에서는 Flow Service API를 사용하여 Square에 대한 기본 연결을 만드는 단계를 안내합니다.
시작하기
이 안내서를 사용하려면 Adobe Experience Platform의 다음 구성 요소에 대해 이해하고 있어야 합니다.
다음 섹션에서는 Flow Service API를 사용하여 Square에 성공적으로 연결하기 위해 알아야 할 추가 정보를 제공합니다.
필요한 자격 증명 수집
Flow Service이(가) Square과(와) 연결하려면 다음 연결 속성에 대한 값을 제공해야 합니다.
자격 증명 | 설명 |
---|---|
host | Square 인스턴스의 URL. |
clientId | Square 계정과 연결된 클라이언트 ID입니다. |
clientSecret | Square 계정과 연결된 클라이언트 암호입니다. |
accessToken | 액세스 토큰은 OAuth 2.0 인증을 통해 Square 계정을 인증하는 데 사용됩니다. Square에서 액세스 토큰을 가져올 수 있습니다. |
refreshToken | 새로 고침 토큰은 현재 액세스 토큰이 만료되면 새 액세스 토큰을 생성하는 데 사용됩니다. Square에서 새로 고침 토큰을 가져올 수 있습니다. |
connectionSpec.id | 연결 사양은 기본 및 소스 연결 만들기와 관련된 인증 사양을 포함하여 소스의 커넥터 속성을 반환합니다. Square의 연결 사양 ID는 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 입니다. |
이러한 자격 증명과 자격 증명을 얻는 방법에 대한 자세한 내용은 Square OAuth에 대한 설명서를 참조하십시오.
Experience Platform API 사용
Experience Platform API를 성공적으로 호출하는 방법에 대한 자세한 내용은 Experience Platform API 시작에 대한 안내서를 참조하십시오.
기본 연결 만들기
기본 연결은 소스의 인증 자격 증명, 연결의 현재 상태 및 고유한 기본 연결 ID를 포함하여 소스와 Experience Platform 간에 정보를 유지합니다. 기본 연결 ID를 사용하면 소스 내에서 파일을 탐색 및 탐색하고 데이터 유형 및 형식에 대한 정보를 포함하여 수집할 특정 항목을 식별할 수 있습니다.
기본 연결 ID를 만들려면 Square 인증 자격 증명을 요청 매개 변수의 일부로 제공하는 동안 /connections
끝점에 대한 POST 요청을 만듭니다.
API 형식
POST /connections
요청
다음 요청은 Square에 대한 기본 연결을 만듭니다.
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": "Square Base Connection",
"description": "Square Base Connection",
"auth": {
"specName": "OAuth2 Refresh Code",
"params": {
"host": "{HOST}",
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}"
"accessToken": "{ACCESS_TOKEN}"
"refreshToken": "{REFRESH_TOKEN}"
}
},
"connectionSpec": {
"id": "2acf109f-9b66-4d5e-bc18-ebb2adcff8d5",
"version": "1.0"
}
}'
속성 | 설명 |
---|---|
auth.params.host | Square 인스턴스의 URL. |
auth.params.clientId | Square 계정과 연결된 클라이언트 ID입니다. |
auth.params.clientSecret | Square 계정과 연결된 클라이언트 암호입니다. |
auth.params.accessToken | 액세스 토큰은 OAuth 2.0 인증을 통해 Square 계정을 인증하는 데 사용됩니다. Square에서 액세스 토큰을 가져올 수 있습니다. |
auth.params.refreshToken | 새로 고침 토큰은 현재 액세스 토큰이 만료되면 새 액세스 토큰을 생성하는 데 사용됩니다. Square에서 새로 고침 토큰을 가져올 수 있습니다. |
connectionSpec.id | Square 연결 사양 ID: 2acf109f-9b66-4d5e-bc18-ebb2adcff8d5 . |
응답
성공한 응답은 고유 연결 식별자(id
)를 포함하여 새로 만든 연결을 반환합니다. 이 ID는 다음 자습서에서 데이터를 탐색하는 데 필요합니다.
{
"id": "24151d58-ffa7-4960-951d-58ffa7396097",
"etag": "\"65015e9d-0000-0200-0000-5e89162d0000\""
}
다음 단계
이 자습서에 따라 Flow Service API를 사용하여 Square 연결을 만들고 연결의 고유 ID 값을 얻었습니다. 다음 자습서에서 이 ID를 사용하여 흐름 서비스 API를 사용하여 결제 애플리케이션을 탐색하는 방법을 배울 수 있습니다.