Aller au contenu principal

Consentements

Endpoints en lecture seule pour récupérer l'historique des consentements donnés (ou refusés) par les employé·e·s. Module requis : MaCarteDeMembre.

Chaque modification d'un consentement génère un nouvel enregistrement — l'historique complet est exposé. Pour l'état courant d'un employé, prenez le dernier enregistrement par date pour chaque objetDeConsentement.

Stratégie d'incrémentalité

Stockez la date du dernier consentement traité (dateConsentement) et passez-la en apres au prochain appel pour ne récupérer que les nouveaux. Voir Guide — recherche et filtrage.

Recherche par date

GET /b2b/v1/consentement

Retourne l'historique de consentements selon les filtres optionnels.

Filtres

NomEmplacementTypeDescription
apresQueryDateTime?dateConsentement >= apres (inclusif, format ISO 8601 UTC)
idExterneQuerystring?Filtre par identifiant externe d'un employé

Les deux filtres sont optionnels et combinés par ET logique. Sans aucun filtre, tous les consentements du client sont retournés.

Réponse

[
{
"idExterne": "EMP-001",
"dateConsentement": "2024-01-15T14:30:00Z",
"consent": true,
"employe": {
"idExterne": "EMP-001",
"prenom": "Jean",
"nom": "Dupont",
"noMembre": "M-001",
"courriel": "jean.dupont@example.com"
},
"objetDeConsentement": {
"identifiantExterne": "CONSENT-001",
"titre": "Communications marketing"
}
}
]

Champs

NomTypeDescription
idExternestring?Identifiant externe de l'employé qui a donné le consentement
dateConsentementDateTimeHorodatage UTC d'enregistrement du consentement
consentbooltrue = consentement accordé ; false = consentement refusé
employeobjectCoordonnées complètes de l'employé (B2BEmployeItem)
objetDeConsentement.identifiantExternestringIdentifiant externe de l'objet de consentement
objetDeConsentement.titrestringTitre affiché de l'objet au moment du consentement

Exemple

curl -X GET "https://api.macartedemembre.com/b2b/v1/consentement?apres=2024-01-01T00:00:00Z" \
-H "X-Api-Key: votre-cle-api"

Consentements par employé

GET /b2b/v1/consentement/{idExterne}

Retourne l'historique de consentements d'un employé spécifique. Combinable avec apres pour limiter la fenêtre temporelle.

Paramètres

NomEmplacementTypeDescription
idExternePathstringIdentifiant externe de l'employé
apresQueryDateTime?dateConsentement >= apres (optionnel)

Exemple

curl -X GET "https://api.macartedemembre.com/b2b/v1/consentement/EMP-001?apres=2024-01-01T00:00:00Z" \
-H "X-Api-Key: votre-cle-api"

Voir aussi