Liste des endpoints disponibles :

/customers-consents/{customer_id} (GET)

Permet de gérer et récupérer l'historique des consentements des profils.

Endpoint: social-sb.com/api/v2/customers-consents/{customer_id}

Verb: GET

Paramètres obligatoires :

• customerId : Identifiant SPREAD du customer

Paramètres complémentaires :

Aucun

Réponse :

"customer":
{
 "id": "123456",
 "consents":
 [
    {
        "consentId": "9876",
        "trackId": "1000",
        "consentTechName": "NewsEmail",
        "customerConsentCreatedAt": "2018-06-11 13:03:05",
        "customerConsentStatus": "accepted",
        "customerConsentSource": "campaignParticipation",
        "customerConsentSourceId": "65745"
    },
    {
        "consentId": "9875",
        "trackId": "1001",
        "consentTechName": "NewsSMS",
        "customerConsentCreatedAt": "2018-06-11 13:03:38",
        "customerConsentStatus": "refused",
        "customerConsentSource": "campaignParticipation",
        "customerConsentSourceId": "65746"
    },
    {
        "consentId": "9874",
        "trackId": "1002",
        "consentTechName": "J'accepte d'être contacté occasionnellement par téléphone",
        "customerConsentCreatedAt": "2018-06-11 13:03:44",
        "customerConsentStatus": "unknown",
        "customerConsentSource": "campaignParticipation",
        "customerConsentSourceId": "65747"
    }
 ]
},
"count": 3,
"nextPageUrl": "<http://social-sb.com/api/v2/customers-consents/123456?startAt=3>"

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "<https://social-sb.com/api/v2/customers-consents/123456>");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:cle_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
• consentId ⇒ seul le consentement ayant pour ID le paramètre sera remonté
• consentTechName ⇒ seul le consentement ayant pour tech name le paramètre sera remonté
• customerConsentStatus ⇒ seuls les consentements ayant le statut passé en paramètre seront remontés. Les valeurs possibles :
  • accepted
  • refused
  • toBeConfirmed
  • unknown
• customerConsentSource ⇒ seuls les consentements venant d'une source comme celle passée en paramètre seront remontés. Les valeurs possibles :
  • campaignParticipation
  • duplicationFromAPartnership
  • confirmationOfADoubleOptin
  • unsubscriptionUnifiedMessaging
  • manualImport
  • automaticImport
  • upstreamAPIGET
  • upstreamAPIGETJS
  • upstreamAPIPOST
  • unifiedMessaging
  • transactionalEmail
  • optinsMigration
  • manualUpdate
  • migrationOfCustomersToALegalBasis
  • prospectMigrationToALegalBasis
  • upstreamAPIv2POST
  • publicConsentManagementUserInterface

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és par pages (max 5000)

**/customers-consents (GET)**

Permet de récupérer tous les customers ayant répondu à un consentement.