Documentation librairie fairandsmart.js
Fairandsmart propose une librairie opensource compatible avec tous les navigateurs vous permettant d’intégrer rapidement les différentes fonctionnalités disponibles avec le module Right Consents.
Cette documentation référence toutes les classes et les méthodes disponibles dans la librairie Javascript fairandsmart.js.
Cette documentation couvre l’intégralité des fonctionnalités mises à disposition dans le fichier fairandsmart.js. Si vous désirez en apprendre plus sur la solution Right Consents, référez vous à la documentation adéquate.
Prérequis
Il est convenu ici que vous disposez des connaissances suffisantes de l’environnement javascript et du développement web. Il est aussi considéré que vous connaissez la terminologie de la solution Right Consents de FairAndSmart et des outils mis à disposition. Si tel n’est pas le cas, référez vous à notre documentation avant de poursuivre.
Importer Fairandsmart.js
via HTML script tag
<script src="https://link.to.assets/consent.js" sha-256="hash" type="text/javascript" />
Le SDK sera disponible dans la variable window.FairAndSmart
Exemple:
const collector = new FairAndSmart.ConsentCollector();
via npm (recommandé)
npm i @fairandsmart/consent-manager
Vous pourrez alors importer les composants du SDK avec import
Exemple:
import { ConsentCollector } from '@fairandsmart/consent-manager';
Initialisation
Le SDK a besoin d'être initialisé avant de pouvoir être utilisé. Selon la configuration de vos offres et ce que vous voulez effectuer avec fairandsmart.js, vous devrez spécifier les différents points d’accès aux services FairAndSmart.
Si vous préférez utiliser FairAndSmart uniquement pour les types, interfaces et énumérations mises à disposition, vous pouvez passer cette étape.
Avant de pouvoir utiliser les fonctionnalités de collecte du SDK, vous devez appeler la méthode RightConsents.init :
import { RightConsents } from '@fairandsmart/consent-manager';
import { defaultHttpClient } from '@fairandsmart/consent-manager/http';
RightConsents.init({
apiRoot: 'https://consent-manager.fairandsmart.com',
catalogRoot: 'https://catalog.fairandsmart.com',
httpClient: defaultHttpClient,
});
Cette méthode prend en paramètre un objet de configurations comportant les champs suivants :
Champ | Description | Valeur par défaut |
|---|---|---|
apiRoot | Il s’agit du point d’accès de votre Consent Manager FairAndSmart. Le SDK utilisera cette URI pour interroger la base de consentement de vos utilisateurs. | ‘no_endpoint’ |
catalogRoot | Il s’agit du point d’accès du catalogue de donnée de FairAndSmart. Cette option n’est a spécifier que si vous avez souscrit à l’offre Right Data - permettant de collecter des données utilisateur. | ‘no_endpoint’ |
httpClient | Il s’agit d’un client http par lequel tous les appels http du SDK passeront. La fonction doit être du type |
|