파트너 API

API를 통한 고객 데이터 동기화

고객 데이터를 CitrusAd에 전송

고객 데이터를 CitrusAd에 전송하려면 아래와 비슷한 명령을 사용합니다. 아래 customers 필드는 더미 데이터이며 여기에서 예시로만 제공됩니다.

📘

전체 customer 개체 필드는 선택 사항입니다. 필드 값 없이 customer 개체를 푸시하면 새로운 id 가 생성되므로 다음의 경우 id 를 지정하지 마십시오. customer 개체를 생성하려는 경우.

다음 필드의 모든 값은 소매업자가 임의로 구성할 수 있습니다. targetingData . 자세한 내용은 참조 페이지를 확인하십시오.

POST $BASE_URL/v1/customers HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customers": [
        {
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "targetingData": {
            "customer_type": "Corporate"
            }
        }
    ]
}

성공하면 다음 오브젝트가 반환됩니다.

{
    "customers": [
        {
            "targetingData": {
                "customer_type": "Corporate"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "yearOfBirth": 0
        }
    ]
}

여러 고객 동기화

여러 고객을 동기화하는 경우 요청당 최대 100개 항목을 묶음으로 전송할 수 있습니다. 요청 횟수는 무제한입니다.

푸시된 고객 페이로드 순서는 반환된 결과의 순서와 동일하므로 데이터를 통합자가 백엔드에서 유지하는 고객 묘사와 일치시킬 수 있습니다.

POST $BASE_URL/v1/customers HTTP/1.1 
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customers": [
        {
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "targetingData": {
            "customer_type": "Corporate"
            }
        },
        {
            "id": "c7792468-07ea-4cc3-9b1a-975bb43dfa02",
            "targetingData": {
            "customer_type": "Retail"
            }
        }
    ]
}

성공하면 다음 오브젝트가 반환됩니다.

{
    "customers": [
        {
            "targetingData": {
                "customer_type": "Corporate"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "i4358f9b-bbb9-49fb-93fe-3ad481ce564",
            "yearOfBirth": 0
        },
        {
            "targetingData": {
                "customer_type": "Retail"
            },
            "gender": "Other",
            "teamId": "9be784a8-22fc-4315-a335-b7d2c2494f0a",
            "postcode": "",
            "suburb": "",
            "id": "c7792468-07ea-4cc3-9b1a-975bb43dfa02",
            "yearOfBirth": 0
        }
    ]
}

🚧

gender,postcode,suburb,yearOfBirth 필드

이 필드는 더 이상 사용되지 않으며 기록 통합 용도로만 남아 있습니다.

대량 고객 데이터 수집

API는 한 번에 100 묶음을 허용하기 때문에 통합 시 첫 번째 고객 데이터 묶음을 수집 파일로 전송하는 것이 좋습니다.