> For the complete documentation index, see [llms.txt](https://doc.commandersact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.commandersact.com/fr/fonctionnalites/consent-management/onsite-api/getting-started.md). # Premiers pas L'API Consent de Commanders Act est utilisée pour interagir avec Commanders Act Consent en JavaScript. Elle propose actuellement uniquement des méthodes pour recevoir et mettre à jour le consentement, mais elle sera enrichie de méthodes supplémentaires à l'avenir. ## Stub API Il est nécessaire d'installer un stub JavaScript avant de pouvoir utiliser l'une des méthodes de l'OnSite API. Le stub est utilisé pour mettre en tampon toutes les méthodes dans un tableau JavaScript jusqu'à ce que le JavaScript de la bannière de consentement Commanders Act soit chargé et prêt à traiter les méthodes. Cela permet d'utiliser l'OnSite API avant que la Commanders Act Consent Banner (fichier JavaScript) ne soit chargée. ```javascript window.caReady = window.caReady || []; window.cact = function() { window.caReady.push(arguments); }; ``` `window.caReady` est un tableau JavaScript qui met en mémoire tampon les interactions avec l'API. `window.cact` est une fonction JavaScript utilisée pour interagir avec l'OnSite API. {% hint style="success" %} Si vous travaillez dans une grande équipe et n'êtes pas sûr que le stub ait déjà été installé, il est acceptable d'installer le stub JavaScript plusieurs fois. {% endhint %} ## Méthodes Après avoir installé le stub, il est alors possible d'utiliser n'importe laquelle des méthodes de l'OnSite API via le `window.cact` fonction. {% hint style="info" %} Les méthodes disponibles sont listées dans la documentation sous **ONSITE API**. {% endhint %} Chaque méthode suit une signature stricte : ```javascript cact(command, [options,] [callback]) ``` | Argument | Descriptions | Obligatoire | | ---------- | ---------------------------------------------------------------------------------------------------------------- | ----------- | | `command` | Un identifiant sous forme de chaîne utilisé pour sélectionner la méthode souhaitée. | Obligatoire | | `options` | Un objet JavaScript qui inclut les données transmises à la méthode. | Facultatif | | `callback` | Une fonction de rappel JavaScript utilisée pour recevoir des informations ou des événements depuis l'OnSite API. | Facultatif | Ci-dessous, vous trouverez un exemple de méthode utilisée pour recevoir le statut du consentement Commanders Act avec l'OnSite API. Cet exemple ne fournit qu'une fonction de rappel pour recevoir le consentement, sans fournir d'options. ```javascript cact('consent.get', function (result) { if (result.consent.status === "all-on") { // Consentement disponible pour toutes les catégories. } }); ``` {% hint style="warning" %} Les méthodes de l'OnSite API sont appelées de manière asynchrone. Au cas où, par exemple, vous auriez besoin d'informations de manière synchrone dans le `` du document, il est recommandé de mettre en cache et de récupérer le résultat de l'API dans `localStorage`. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://doc.commandersact.com/fr/fonctionnalites/consent-management/onsite-api/getting-started.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.