> 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/sources/sources-catalog/web/containers/best-practices/apis/onsite-api.md).

# API onsite

## Pour bien démarrer

L’API onsite permet d’interagir avec les fonctionnalités de Commanders Act en JavaScript.

## Utilisation

L’API onsite se compose d’une seule fonction, `cact()`, avec la signature stricte suivante :

```javascript
cact(command, [options,] [callback])
```

| Argument   | Descriptions                                                                                                 | Obligatoire |
| ---------- | ------------------------------------------------------------------------------------------------------------ | ----------- |
| `command`  | Un identifiant sous forme de chaîne de caractères permettant de sélectionner la méthode souhaitée.           | Obligatoire |
| `options`  | Un objet JavaScript contenant les données transmises à la méthode.                                           | Facultatif  |
| `callback` | Une fonction de rappel JavaScript utilisée pour recevoir des informations ou des événements de l’API onsite. | Facultatif  |

L’API onsite est incluse dans chaque conteneur et bannière de confidentialité.

## Envoyer un événement

Pour envoyer des données d’événement à la plateforme Commanders Act server-side, utilisez cette commande :

```javascript
cact('<event_name>', {<event_params>});
```

Exemple : pour envoyer un événement d’achat :

```javascript
cact('purchase', { 
  id:'1234',
  currency: 'EUR',
  //...
});
```

## Obtenir des informations

Pour obtenir différentes valeurs depuis Commanders Act, utilisez cette commande :

```javascript
cact(get command, [callback])
```

Exemple : pour obtenir le consentement depuis TrustCommander, vous pouvez appeler l’API `consent.get` comme suit :

```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’API onsite sont appelées de manière asynchrone. Si, par exemple, vous avez besoin d’informations de manière synchrone dans le `<head>` du document, il est recommandé de mettre en cache le résultat de l’API et de le récupérer dans `localStorage`.
{% endhint %}

## Gestion des erreurs

Vous pouvez gérer les erreurs à l’aide de la propriété error de l’objet de rappel.\
Exemple :

```javascript
cact('consent.get', function(result) {

    if (result.error) {
    
        // Gérer l’erreur
    
    }
    else if (result.consent.status === "all-on") {
        
        // Consentement disponible pour toutes les catégories.
        
    }
});
```

## Stub de l’API (facultatif)

Pour les usages avancés, nous fournissons également un stub d’API que vous pouvez ajouter si vous devez interagir avec l’API avant le chargement des conteneurs ou des bannières.\
Ce stub est déjà inclus dans les conteneurs et les bannières de confidentialité ; vous n’avez donc pas besoin de l’ajouter dans la plupart des cas.\
Le stub met en mémoire tampon toutes les méthodes dans un tableau JavaScript, jusqu’à ce que le JavaScript de Commanders Act soit chargé et prêt à les traiter. Cela permet, par exemple, d’utiliser l’API onsite avant le chargement du JavaScript de TrustCommander.

```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’API onsite.

{% hint style="success" %}
Si vous travaillez au sein d’une grande équipe et ne savez pas si le stub a déjà été installé, vous pouvez l’installer plusieurs fois.
{% 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://doc.commandersact.com/fr/fonctionnalites/sources/sources-catalog/web/containers/best-practices/apis/onsite-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
