API para socios

Sincronización de datos de clientes a través de API

Envío de datos de clientes a CitrusAd

Para enviar datos de clientes a CitrusAd, utilice un comando similar al siguiente. Tenga en cuenta que los datos del campo customers es un campo de datos ficticios y se proporciona aquí únicamente a modo de ejemplo.

📘

Todo customer los campos de objeto son opcionales. Si incorpora un objeto customer sin ningún valor de campo, una nueva id se creará, así que no especifique una id si va a crear objetos customer .

Todos los valores del campo targetingData son arbitrarios y configurables por el minorista. Visite la página de referencia para obtener más información.

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

Si se realiza correctamente, se devolverá el siguiente objeto:

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

Sincronización de múltiples clientes

Si va a sincronizar varios clientes, puede enviar hasta 100 elementos en lote con cada solicitud. La cantidad de solicitudes que puede realizar es ilimitada.

El pedido de carga del cliente enviado es el mismo pedido que el resultado devuelto, lo que hace posible que los datos conserven la coherencia con la representación del cliente que el integrador mantiene en su backend.

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

Si se realiza correctamente, se devolverá el siguiente objeto:

{
    "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 campos

Estos campos ya no se utilizan y solo se conservan para integraciones históricas.

Incorporación de datos masivos de clientes

Al realizar la integración, le recomendamos que envíe su primer lote de datos de clientes como archivo para incorporación, ya que la API acepta lotes de 100 a la vez.