API - Cagnotte

Owned by Stéphane Larzet (Unlicensed)
Last updated: 11 Dec 2019 by Yani (désactivé) Kara (Unlicensed)
3 min read

 Pour être informés de toutes les mises à jour concernant l’API v2 de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2


La cagnotte SPREAD fonctionne automatiquement par défaut, cette API vous permet d'ajouter vous même des points dans les cagnottes de vos clients. 

Méthodes disponibles


POST => social-sb.com/api/v2/cagnottes

Paramètres obligatoires : 

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

    OU

    "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 : 

Si POST ok alors 

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

Sinon un message d'erreur s'affiche. 


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);
curl_setopt($curl, CURLOPT_USERPWD, "cle_publique:cle_privee"); // À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker" en bas de page
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);

GET => social-sb.com/api/v2/cagnottes


Permet de récupérer toutes les lignes de cagnotte de sa CRM

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok ⇒

Exemple de 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"

Sinon affichage message d'erreur.


Exemple d'appel PHP :

Exemple d'appel PHP
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/cagnottes"); 
curl_setopt($curl, CURLOPT_USERPWD, "cle_publique:cle_privee"); // À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker" en bas de page
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)