API partenaire

Synchroniser les données client par l'API

Envoyer des données client à CitrusAd

Pour envoyer des données client à CitrusAd, utilisez une commande similaire à celle ci-dessous. Notez que les données inscrites dans le champ customers sont ici factices et ne sont fournies qu'à titre d'exemple.

📘

Tous customer sont facultatifs. Si vous ajoutez un objet customer sans aucune valeur de champ, un nouvel id sera créé. Par conséquent, ne spécifiez aucun id si vous voulez juste créer des objets customer .

Toutes les valeurs du champ targetingData sont arbitraires et configurables par le détaillant. Consultez la page de référence pour plus d'informations.

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

En cas de succès, l'objet suivant sera renvoyé :

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

Synchroniser plusieurs clients

Si vous synchronisez plusieurs clients, vous pouvez envoyer jusqu'à 100 articles par lot avec chaque demande. Le nombre de requêtes que vous pouvez effectuer est illimité.

La commande de la charge utile client envoyée est la même que celle du résultat renvoyé, ce qui garantit que les données restent conformes à la présentation du client que gère l'intégrateur dans son back-end.

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

En cas de succès, l'objet suivant sera renvoyé :

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

Veuillez noter que ces champs ne sont plus utilisés et sont uniquement conservés pour les intégrations historiques.

Ingérer des données client en masse

Nous vous recommandons d'envoyer votre premier lot de données client à ingérer sous forme de fichier, car l'API accepte des lots de 100 à la fois.