API - Participation

Owned by Stéphane Larzet (Unlicensed)
Last updated: 28 Jun 2019 by Former user (Deleted)
2 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

Méthodes disponibles


GET Participation

Cette méthode permet de récupérer une action grâce à son identifiant.

GET ⇒ social-sb.com/api/v2/participations/{id}

Paramètres obligatoires :

  • "id" => identifiant SPREAD de la participation

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"participation": [
{
 "id": "45454545",
 "customerId": "123456",
 "campaignId": "654321",
 "createdAt": "2017-03-13 15:57:59",
 "updatedAt": "2017-03-13 16:02:59",
 "participationComplete": null,
 "connectionBy": "email",
 "becameFanFacebook": "0",
 "becameFanTwitter": "0",
 "becameFanGoogle": "0",
 "becameFanLinkedin": "0",
 "becameFanInstagram": "0",
 "isWinner": "1"
}

Sinon, affichage message d'erreur.

Exemple d'appel PHP :

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


GET Participations

Cette méthode permet de récupérer toutes les participations à des modules pour un site_id.

GET ⇒ social-sb.com/api/v2/participations

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"participations": [
 {
 "id": "45454545",
 "customerId": "123456",
 "campaignId": "654321",
 "createdAt": "2017-03-13 15:57:59",
 "updatedAt": "2017-03-13 16:02:59",
 "participationComplete": null,
 "connectionBy": "email",
 "becameFanFacebook": "0",
 "becameFanTwitter": "0",
 "becameFanGoogle": "0",
 "becameFanLinkedin": "0",
 "becameFanInstagram": "0",
 "isWinner": "1"
 },
 {
 "id": "67676767",
 "customerId": "123457",
 "campaignId": "543222",
 "createdAt": "2017-03-13 16:14:12",
 "updatedAt": "2017-03-13 16:38:32",
 "participationComplete": 1,
 "connectionBy": "Facebook",
 "becameFanFacebook": "0",
 "becameFanTwitter": "0",
 "becameFanGoogle": "0",
 "becameFanLinkedin": "0",
 "becameFanInstagram": "0",
 "isWinner": null
 },
],
"count": 2,
"nextPageUrl": "http://social-sb.com/api/v2/participations?startAt=2"

Sinon affichage message d'erreur.

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/participations");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_prive");
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 participations créées après la date passée en paramètre seront remontées
  • "createBefore" ⇒ seules les participations créées avant la date passée en paramètre seront remontées
  • "modifiedAfter" ⇒ seules les participations modifiées après la date passée en paramètre seront remontées
  • "modifiedBefore" ⇒ seules les participations modifiées avant la date passée en paramètre seront retournées
  • "customerId ⇒ seules les participations du customer passé en paramètre seront remontées
  • "campaignId" ⇒ seules les participations appartenant à la campagne passée en paramètres seront retournées
  • "order" ⇒ seules les participations qui ont provoqué un commande seront remontées (order=1)
  • "complete" ⇒ seules les participations complètes (le customer est allé au bout de la confirmation) seront remontées.

Les paramètres sur la pagination :

  • "startAt" ⇒ permet de commencer la liste des campagnes à partir de l'occurence passée en paramètre
  • "maxResult" ⇒ permet de limiter le nombre de campagnes remontées par pages (max 5000)