# Déclencher des parcours client en utilisant l'entrée basée sur l'API

L'entrée basée sur l'API vous permet de lancer un parcours client dès qu'un événement commercial spécifique se produit. Pour démarrer une campagne, vous devez envoyer une requête API spéciale.


## Configuration

1. Créez un parcours avec une entrée basée sur l'API

<video src="/customer-journey-api-based-entry-1.webm" alt="Interface du Customer Journey Builder montrant comment créer un nouveau parcours avec l'élément d'entrée basée sur l'API" autoplay loop muted playsinline />

2. Double-cliquez sur l'étape d'entrée basée sur l'API. La fenêtre de configuration de l'entrée s'ouvrira.

3. Vous pouvez modifier le contenu des notifications push et des e-mails à chaque lancement du parcours en utilisant des placeholders de contenu. La valeur de chaque placeholder peut être modifiée dans la requête. Si vous n'avez pas besoin de cette option, vous pouvez sauter cette étape.

> Par exemple, vous créez un parcours pour notifier les abonnés de la sortie d'un nouvel épisode de podcast. En utilisant un placeholder de contenu, vous pouvez changer le titre du podcast à chaque fois que vous lancez le parcours.

D'abord, ajoutez les noms des placeholders dans la fenêtre de configuration de l'entrée basée sur l'API. Vous pouvez utiliser les noms qui vous conviennent.

<video src="/customer-journey-api-based-entry-2.webm" alt="Fenêtre de configuration de l'entrée basée sur l'API montrant comment ajouter des noms de placeholders pour du contenu dynamique" autoplay loop muted playsinline />

Maintenant, créez un [préréglage](/fr/product/content/presets/) de notification push ou d'e-mail et insérez le placeholder à la place du texte que vous souhaitez modifier. Le placeholder doit être dans l'un des formats suivants selon vos besoins :

* `{placeholder_name|format_modifier|}` – si la valeur du placeholder n'est pas spécifiée lors du lancement de la campagne, les utilisateurs verront un espace vide à sa place.
* `{placeholder_name|format_modifier}` – si la valeur du placeholder n'est pas spécifiée et n'a pas déjà été assignée à un utilisateur (au cas où vous auriez utilisé un Tag comme placeholder), le message ne sera pas envoyé.

<details>

<summary>Modificateurs de format</summary>

* CapitalizeFirst – met en majuscule la première lettre de la valeur d'un placeholder ;
* CapitalizeAllFirst – met en majuscule la première lettre de chaque mot de la valeur d'un placeholder si la valeur est composée de plusieurs mots ;
* UPPERCASE – met toutes les lettres en majuscules ;
* lowercase – met toutes les lettres en minuscules ;
* regular – insère la valeur d'un placeholder exactement comme spécifié dans la requête, sans aucune modification.

</details>

<img src="/customer-journey-api-based-entry-3.webp" alt="Éditeur de préréglage de notification push montrant un exemple de syntaxe de placeholder avec des modificateurs de format dans le contenu du message"/>

<Aside type="note">
Vous pouvez également utiliser un nom de Tag existant au lieu d'un nom de placeholder. Dans ce cas, vous devez configurer l'écrasement de la valeur de ce Tag par la valeur spécifiée dans la requête, comme décrit ci-dessous.
</Aside>

Lors de la configuration de l'étape Push ou E-mail dans votre parcours, sélectionnez le préréglage créé et activez l'option **Personnaliser le message avec les attributs d'événement**. Sélectionnez les placeholders que vous souhaitez modifier dans la requête lors du lancement du parcours. Choisissez une **Entrée basée sur l'API** comme source et le nom du placeholder comme attribut dynamique :

<video src="/customer-journey-api-based-entry-4.webm" title="Configuration de l'étape Push ou E-mail montrant l'option Personnaliser le message avec les attributs d'événement et la sélection de la source d'entrée basée sur l'API" autoplay loop muted playsinline />

Cliquez sur **Appliquer** pour enregistrer les modifications.

4\. Dans la fenêtre de configuration de l'entrée, copiez le modèle de requête pour le modifier :

<img src="/customer-journey-api-based-entry-5.webp" alt="Fenêtre de configuration de l'entrée basée sur l'API affichant le modèle de requête API avec le format de l'en-tête d'autorisation"/>
<Aside>
Pour lancer un parcours via l'API, vous devez inclure un jeton d'autorisation valide dans l'en-tête d'autorisation.

**Format d'en-tête requis**

 ```http
 Authorization: Api <your_api_token>
 ```
 **Exemple**

 ```http
 Authorization: Api c8dc6435-xxxxxxxxxxxxxxx
 ```
</Aside>

5. Ajoutez des filtres d'audience au paramètre « filter » en utilisant le [langage de segmentation](/fr/developer/api-reference/segmentation-filters-api/segmentation-language/). Veuillez noter que vous devez configurer les [Tags](/fr/developer/guides/audience-and-segmentation/tags/) nécessaires à l'avance.

Par exemple, si vous souhaitez cibler le parcours sur les utilisateurs qui ont ajouté l'article _Socks_ à leur _Wishlist_, la valeur de « filter » doit ressembler à ce qui suit :

```
    "filter": "A("12345-12345") * "T("Wishlist", EQ, "Socks")"
```

Dans cet exemple, vous devez avoir un Tag _Wishlist_ configuré dans votre application.

<Aside type="note">
Le code de votre application sera automatiquement ajouté au paramètre « filter » au format `A(\"12345-12345\")`. Veuillez ne pas le supprimer ni le modifier.

De plus, gardez à l'esprit que les guillemets ("") et les barres obliques inverses (\\) doivent être échappés avec une barre oblique inverse (\\) dans les requêtes JSON.
</Aside>

6. Si vous avez configuré des placeholders, spécifiez le contenu souhaité comme leurs valeurs :

<img src="/customer-journey-api-based-entry-6.webp" alt="Modèle de requête API montrant la configuration des valeurs de placeholder pour le contenu dynamique lors du lancement du parcours"/>

7. Si l'option **Limites de débit des messages** est activée, le nombre d'utilisateurs entrant dans le parcours en même temps chaque seconde sera limité. Vous pouvez utiliser la valeur par défaut de 5000 utilisateurs par seconde ou définir un autre nombre.

<img src="/customer-journey-api-based-entry-7.webp" alt="Configuration de l'entrée basée sur l'API montrant l'option Limites de débit des messages avec une valeur par défaut de 5000 utilisateurs par seconde"/>

<Aside type="tip">
Nous vous recommandons de maintenir la valeur entre 5000 et 10000 utilisateurs par seconde. Si la valeur est trop basse, il se peut que votre audience mette plus de temps à entrer dans le parcours. Si la valeur est trop élevée, le service qui traite vos données peut être surchargé.
</Aside>

8. Si vous prévoyez de redémarrer votre campagne fréquemment et que vous ne voulez pas que les mêmes utilisateurs entrent plusieurs fois dans le parcours, définissez un [Plafonnement de la fréquence](/fr/product/customer-journey/journey-settings#frequency-capping).

> Par exemple, vous avez créé une campagne pour informer les utilisateurs d'une réduction de prix sur un produit spécifique. Vous souhaitez relancer le parcours plusieurs fois en envoyant plusieurs requêtes avec des filtres d'audience différents. Dans ce cas, vous pouvez ajouter un plafonnement de la fréquence afin que la notification ne soit pas envoyée à plusieurs reprises aux utilisateurs qui correspondent à plusieurs filtres.

9. Si vous souhaitez qu'un parcours se lance chaque fois qu'un certain événement commercial se produit, automatisez la requête à l'aide d'un webhook. Une fois l'événement survenu, le webhook doit envoyer automatiquement la requête pour démarrer le parcours.

Vous pouvez également envoyer la requête manuellement si vous n'avez pas besoin d'automatisation.

<Aside type="note">
* Si vous modifiez les conditions de segmentation lors de l'envoi d'une nouvelle requête, cela n'affectera pas les utilisateurs qui sont déjà entrés dans le parcours.
* Si vous modifiez le contenu du message lors de l'envoi d'une nouvelle requête, tous les utilisateurs recevront la nouvelle version du message (y compris ceux qui sont déjà entrés dans le parcours mais n'ont pas encore reçu ce message).
</Aside>