API đối tác

Đồng bộ hóa dữ liệu khách hàng thông qua API

Gửi dữ liệu khách hàng đến CitrusAd

Để gửi dữ liệu khách hàng đến CitrusAd, hãy sử dụng lệnh tương tự như lệnh bên dưới. Lưu ý rằng dữ liệu trong customers trường là dữ liệu giả và chỉ được cung cấp ở đây làm ví dụ.

📘

Tất cả các trường đối tượng customer đều không phải là trường bắt buộc. Nếu bạn đẩy một đối tượng customer không có bất kỳ giá trị trường nào thì một id sẽ được tạo, vì vậy đừng chỉ định một id nếu bạn đang tạo các đối tượng customer .

Mọi giá trị trong trường targetingData đều là ngẫu nhiên và có thể định cấu hình bởi nhà bán lẻ. Vui lòng truy cập trang danh sách tham chiếu chi tiết để biết thêm thông tin.

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"
            }
        }
    ]
}

Nếu thành công, đối tượng sau sẽ được trả về:

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

Đồng bộ hóa nhiều khách hàng

Nếu bạn đang đồng bộ hóa nhiều khách hàng, bạn có thể gửi tối đa 100 mục trong một đợt với mỗi yêu cầu. Không có giới hạn về số lượng yêu cầu bạn có thể gửi.

Lệnh tải trọng của khách hàng được đẩy có cùng thứ tự với kết quả được trả về, khiến dữ liệu vẫn phù hợp với hình thái của khách hàng mà bên tích hợp duy trì trong backend của họ.

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"
            }
        }
    ]
}

Nếu thành công, đối tượng sau sẽ được trả về:

{
    "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 trường

Vui lòng lưu ý rằng các trường này không còn được sử dụng nữa và chỉ còn lại cho các tích hợp lịch sử.

Nhập dữ liệu khách hàng hàng loạt

Khi tích hợp, chúng tôi khuyên bạn nên gửi lô dữ liệu khách hàng đầu tiên dưới dạng tệp để nhập, vì API chấp nhận các lô 100 mỗi lần.