API - Consentement

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 Consent

Récupère les valeurs d'un consentement

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

Paramètres obligatoires :

  • "id" : l'identifiant SPREAD du consentement

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"consent": 
{ 
"id": "9876", 
"consentType": "Default newsletter", 
"consentName": "Informations commerciales par email", 
"consentTechName": "NewsEmail", 
"createdAt": "2018-02-07T10:24:34+0000", 
"updatedAt": "2018-04-05T13:33:31+0000" 
}

Sinon, affichage d'un message d'erreur


Exemple d'appel PHP :

$curl = curl_init(); curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/consents/9876"); 
// 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);


GET Consents

Récupère les valeurs de tous les consentements d'un site_id.

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

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok alors

"consents": [ 
{ 
"id": "9876", 
"consentType": "Default phone", 
"consentName": "Informations commerciales par t\u00e9l\u00e9phone", 
"consentTechName": "J'accepte d'\u00eatre contact\u00e9 occasionnellement par t\u00e9l\u00e9phone", 
"createdAt": "2018-02-07T10:24:34+0000", 
"updatedAt": "2018-02-07T10:24:34+0000" 
}, 
{ 
"id": "9875", 
"consentType": "Legal basis legitimate interest", 
"consentName": "Opt-in email", 
"consentTechName": "LegalBasisOptin", 
"createdAt": "2018-04-25T21:42:26+0000", 
"updatedAt": "2018-04-25T21:42:26+0000" 
}, 
{ 
"id": "9874", 
"consentType": "Legal basis legitimate interest", 
"consentName": "Opt-in sms", 
"consentTechName": "LegalBasisOptin",  
"createdAt": "2018-04-25T21:42:26+0000", 
"updatedAt": "2018-04-25T21:42:26+0000" 
}, 
{ 
"id": "9873", 
"consentType": "Legal basis contract", 
"consentName": "Commande", 
"consentTechName": "LegalBasisOrder", 
"createdAt": "2018-04-25T21:42:26+0000", 
"updatedAt": "2018-04-25T21:42:26+0000" 
}, 
{ 
"id": "9872", 
"consentType": "Legal basis contract", 
"consentName": "Inscription", 
"consentTechName": "LegalBasisSignup", 
"createdAt": "2018-04-25T21:42:26+0000", 
"updatedAt": "2018-04-25T21:42:26+0000" 
}, 
{ 
"id": "9871", 
"consentType": "Default newsletter", 
"consentName": "Informations commerciales par email",  
"consentTechName": "NewsEmail", 
"createdAt": "2018-02-07T10:24:34+0000", 
"updatedAt": "2018-04-05T13:33:31+0000" 
}, 
{ 
"id": "9870", 
"consentType": "Default SMS", 
"consentName": "Informations commerciales par SMS", 
"consentTechName": "NewsSMS",  
"createdAt": "2018-02-07T10:24:34+0000", 
"updatedAt": "2018-02-07T10:24:34+0000" 
} 
], 
"count": 7, 
"nextPageUrl": "http://social-sb.com/api/v2/consents?startAt=7"

Sinon, affichage d'un message d'erreur


Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/consents"); 
// 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" ⇒ seuls les consentements créés après la date passée en paramètre seront remontés

  • "createBefore" ⇒ seuls les consentements créés avant la date passée en paramètre seront remontés

  • "modifiedAfter" ⇒ seuls les consentements modifiés après la date passée en paramètre seront remontés

  • "modifiedBefore" ⇒ seuls les consentements modifiés avant la date passée en paramètre seront retournés

Les paramètres sur la pagination :

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

  • "maxResult" ⇒ permet de limiter le nombre de consentements remontées par pages (max 5000)