Listings APIListings API
로그인
POST/api/v4/connected-accounts/trigger-matches

사업장 매칭 시작

연결된 계정의 Google 및 Facebook 프로필을 가져와 Listings API 사업장과 매칭합니다.

API 키가 필요합니다. 헤더 형식과 키 교체는 인증을 참고하세요.

매개변수

본문

이름유형필수설명
inputobject필수Wrapper object. The entire request body must be nested under `input`.
input.connectedAccountIdsarray of strings필수UUIDs of the connected accounts to trigger matches for. Taken from `GET /connected-accounts`.

요청 예시

바로 붙여 넣을 수 있는 본문입니다. 예시 ID와 값을 실제 값으로 바꾸세요.

Request body
{  "input": {    "connectedAccountIds": [      "4f712c17-4f95-42dd-90f4-97171a2e67b5"    ]  }}

응답

200Request accepted. `success` is `true` when the fetch-and-match job was queued for every account; accounts that could not be queued are returned in `failedIds` and `success` is `false`.
Response
{  "data": {    "connectedAccountsTriggerMatches": {      "failedIds": null,      "success": true    }  }}
400Bad request, the body was not wrapped in `input` (error message: `Variable "$input" of required type "ConnectedAccountsTriggerMatchesInput!" was not provided`).
401Unauthenticated, missing or invalid API key.

지정한 연결된 계정이 액세스할 수 있는 모든 Google Business Profile 및 Facebook 프로필을 가져와 Listings API 사업장과 매칭하는 비동기 작업을 시작합니다. success: true 응답은 작업이 대기열에 추가되었음을 의미하며, 실제 매칭은 백그라운드에서 실행됩니다.

요청 구조. 본문은 매칭할 연결된 계정의 배열인 connectedAccountIds를 포함하는 input 객체로 감싸야 합니다. 객체로 감싸지 않은 평면 구조의 본문을 보내면 HTTP 400으로 거부됩니다. 계정 ID는 GET /connected-accounts에서 가져옵니다. 하나 이상의 계정을 대기열에 추가할 수 없는 경우 해당 계정의 ID가 failedIds에 반환되고 success는 false가 됩니다.

사용 사례: 새 계정 연결 후 제안 새로 고침. 고객이 Google 연결 절차를 완료한 직후 해당 계정의 connectedAccountId로 trigger-matches를 호출합니다. 이렇게 하면 제안된 사업장 매칭이 채워지므로 고객이 예약된 동기화를 기다리지 않아도 온보딩 UI에 "등록 정보 N개를 찾았습니다"라고 표시할 수 있습니다.

사용 사례: 사업장 추가 후 매칭 다시 실행. 기존 연결된 계정에 새 Listings API 사업장을 일괄 생성한 경우 매칭을 새로 실행하여 새 사업장이 기존 Google/Facebook 등록 정보와 연결되도록 합니다.

작업은 비동기로 진행되므로 200을 "매칭 완료"로 간주하지 마세요. 연결된 계정 세부 정보 엔드포인트를 폴링하고 requestMatchesStatus가 MATCH_COMPLETED에 도달할 때까지 기다린 다음, confirm-matches 또는 connect-listing을 호출하기 전에 connection-suggestions 엔드포인트에서 결과를 읽습니다.

이 엔드포인트는 Google/Facebook에서 데이터를 실시간으로 가져오는 작업을 대기열에 추가합니다. 위의 요청 구조와 예시 응답은 API 명세를 바탕으로 문서화되었으며, 이 호출은 프로덕션 데이터를 대상으로 실행되지 않습니다.

Request
curl -X POST 'https://listingsapi.com/api/v4/connected-accounts/trigger-matches' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "connectedAccountIds": [        "4f712c17-4f95-42dd-90f4-97171a2e67b5"      ]    }  }'
Run in playground