Avec le tag

La bibliothèque apieng.js (également connue sous le nom de «balise Api Engagement») est une bibliothèque JavaScript permettant de mesurer l'impact des redirections de l'api engagement

Le tag

La balise Api engagement doit être ajoutée en haut de la balise head et avant tout autre script ou balise CSS, et ajoutez votre ID API Engagement

<!-- Api engagement -->
<script>
  (function (i, s, o, g, r, a, m) {
    i["ApiEngagementObject"] = r; (i[r] = i[r] || function () { (i[r].q = i[r].q || []).push(arguments); }), (i[r].l = 1 * new Date()); (a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]); a.async = 1; a.src = g; m.parentNode.insertBefore(a, m);
  })(window, document, "script", "https://app.api-engagement.beta.gouv.fr/jstag.js", "apieng");
  apieng("config", "XX");
 <!--  apieng("trackApplication"); -->
</script>
<!-- End Api engagement -->

Le code ci-dessus fait quatre choses principales:

• Crée un élément <script> qui démarre le téléchargement asynchrone de la bibliothèque JavaScript jstag.js à partir de https://api-engagement.beta.gouv.fr/jstag.js

• Initialise une fonction apieng globale (appelée file d'attente de commandes apieng ()) qui vous permet de planifier l'exécution des commandes une fois que la bibliothèque jstag.js est chargée et prête à l'emploi.

• Ajoute une commande à la file d'attente de commandes apieng () pour créer un nouvel objet de suivi pour la propriété spécifiée via le paramètre 'config'.

• Ajoute une autre commande à la file d'attente de commandes apieng () pour envoyer une page candidature à l'api engagement pour la page actuelle.

Que faire pour mesurer une candidature

Sur votre page d'application, vous devez executer la fonction suivante pour mesurer une candidature

window.apieng && window.apieng("trackApplication")

Comment ca marche ?

Lorsque l'api redirige un visiteur sur votre site et que le jstag est utilise, nous ajoutons en cookie l'id de la mission. Ce cookie à une durée de vie de 30 jours. Lorsque cette personne candidate pour une mission et que vous appelez la fonction trackApplication, nous regardons si le cookie est present et nous faisons un call au serveur.

Nous ne mesurons la candidature UNIQUEMENT si le cookie de l'api engagement est présent !

Quelles données la balise API ENGAGEMENT capture-t-elle?

Lorsque vous ajoutez la balise à votre site Web, elle n'envoie rien au serveur tant que vous n'appelez pas trackApplication. Nous mesurons ensuite la mission qui a permis a candidature ainsi que l'url.