💡

Par défaut, la cagnotte SPREAD fonctionne automatiquement. Cette API vous permet d'ajouter des points dans les cagnottes de vos clients.

/cagnottes/ (POST)

Cette méthode permet d'ajouter des points dans une cagnotte.

Endpoint : https://social-sb.com/api/v2/cagnottes/

Verb : POST

Paramètres obligatoires :

email : Email du customer (dans le payload "contact")

customerId : Identifiant unique SPREAD du customer

cagnotteAmount : le montant à ajouter à la cagnotte du customer (dans le payload "cagnotte")

Paramètres complémentaires :

Aucun

Réponse :

"customer": {
 "id": "123456",
 "cagnotteAmount": "15"
},
"cagnotte": {
 "cagnotteId": "987",
 "cagnotteLineId": "146964",
 "customerId": "123456",
 "campaignId": null,
 "cagnotteLineDate": "2019-08-29 13:36:52",
 "cagnotteLineValidationDate": "2019-08-29 13:36:52",
 "amount": "5",
 "code": ""
}

Exemple d'appel PHP :

$curl_post_data = array(
    'customer' => array (
        'email' => 'email-example@gmail.com'
    ),
    'cagnotte' => [
        'amount' => 1
    ]
);
 
$curl_post_data = json_encode($curl_post_data);
 
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/cagnottes");
curl_setopt($curl, CURLOPT_POSTREDIR, CURL_REDIR_POST_ALL);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_POSTFIELDS, $curl_post_data );
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_VERBOSE, 1);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

/cagnottes/ (GET)

Cette méthode permet de récupérer les cagnottes.

Endpoint : https://social-sb.com/api/v2/cagnottes/

Verb : GET

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

"cagnottes": [
    {
         "cagnotteId": "118196",
         "cagnotteLineId": "535756",
         "customerId": "15130125",
         "campaignId": "46354",
         "cagnotteLineDate": "2019-07-10 08:30:04",
         "cagnotteLineValidationDate": "2019-07-10 08:30:04",
         "amount": "20",
         "code": ""
    },
    {
         "cagnotteId": "118196",
         "cagnotteLineId": "535759",
         "customerId": "15130125",
         "campaignId": null,
         "cagnotteLineDate": "2019-07-10 15:00:23",
         "cagnotteLineValidationDate": "2019-07-10 15:00:23",
         "amount": "-20",
         "code": "kodeKDO_1"
    },
    {
         "cagnotteId": "118196",
         "cagnotteLineId": "535760",
         "customerId": "15130125",
         "campaignId": null,
         "cagnotteLineDate": "2019-07-10 15:00:35",
         "cagnotteLineValidationDate": "2019-07-10 15:00:35",
         "amount": "-1",
         "code": "http:\/\/google.com"
    }
],
"count": 3,
"nextPageUrl": "http://social-sb.com/api/v2/cagnottes?startAt=3"

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/cagnottes");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

Faire une recherche précise :

Il est possible d'affiner la liste retournée en passant des paramètres GET.

Les paramètres d'affinage possibles :

createdAfter ⇒ seules les lignes de cagnotte créées après la date passée en paramètre seront remontées

createBefore ⇒ seules les lignes de cagnotte créées avant la date passée en paramètre seront remontées

modifiedAfter ⇒ seules les lignes de cagnotte modifiées après la date passée en paramètre seront remontées

modifiedBefore ⇒ seules les lignes de cagnotte modifiées avant la date passée en paramètre seront retournées

customerId ⇒ seules les lignes de cagnotte du customer dont l'identifiant est identique à celui passé en paramètre seront retournées

cagnotteId ⇒ seules les lignes de cagnotte de la cagnotte dont l'identifiant est le même que celui passé en paramètre seront retournées

campaignId ⇒ seules les lignes de cagnotte liées à la campagne dont l'identifiant est identique à celui passé en paramètre seront retournées

minAmount ⇒ seules les lignes de cagnotte avec un montant supérieur à la valeur du paramètre seront remontées

maxAmount ⇒ seules les lignes de cagnotte avec un montant inférieur à la valeur du paramètre seront remontées

amount ⇒ seules les lignes de cagnotte avec un montant identique à la valeur du paramètre seront remontées

Les paramètres sur la pagination :

startAt ⇒ permet de commencer la liste des lignes de cagnotte à partir de l'occurence passée en paramètre

maxResult ⇒ permet de limiter le nombre de lignes de cagnotte remontées par pages (max 5000)

🆘

Si vous avez d’autres questions sur ce sujet, vous pouvez contacter le support. 💬

Cagnotte

/cagnottes/ (POST)

/cagnottes/ (GET)