## Ce que c'est
Une intégration tout simplement géniale pour connecter votre compte Aftership à votre bot Botpress . Suivez les expéditions en temps réel et informez les utilisateurs directement par le biais de votre bot lorsque des mises à jour ont lieu.
Comment ça marche
Lors de l'activation de l'intégration, un abonnement Webhook est configuré pour votre compte Aftership à l'aide de la API Key fournie. Ce site webhook envoie des mises à jour à l'intégration chaque fois qu'il y a un changement significatif dans le statut de suivi d'un envoi.
L'action Track Shipment peut être utilisée pour initier le suivi d'un envoi. Elle nécessite un Numéro de suivi et utilise l'API d'Aftership pour récupérer et surveiller le statut de l'envoi, en intégrant un Identifiant de conversation unique dans les données de suivi. Cet identifiant est ensuite utilisé pour déclencher l'événement Aftership dans la conversation, ce qui permet à votre robot de répondre aux mises à jour de l'expédition.
Conversation Id est un identifiant unique pour chaque conversation. Vous pouvez passer dans ce champ pour intégrer votre identifiant. Lorsque vous recevez une mise à jour de l'Aftership, vous pouvez utiliser dans le champ Conversation ID des Options Avancées du Aftership Event Trigger. Cela dirige la mise à jour vers la conversation appropriée.
Vous pouvez voir le code d'intégration complet sur la page Git de Simply Great Bots : Aftership Repo
Configuration de l'Aftership
Conditions préalables
Vous devez disposer d'un plan Aftership Pro ou supérieur pour recevoir les événements webhook à des fins de suivi.
Obtention de la clé API
- Allez sur Aftership Admin Dashboard.
- Naviguez vers
Developers -> API Keys.
- Cliquez sur
Create API Key, nommez votre clé, et sélectionnez Save.
- Copiez et collez votre clé API dans un endroit sûr, vous en aurez besoin lors de l'installation de Botpress .
Webhook et Secret
- Naviguez vers Tracking Dashboard -> Notifications -> Webhooks.
- Copiez votre secret Webhook et collez-le dans un endroit sûr. Vous en aurez besoin lors de l'installation de Botpress .
- Cliquez sur "Ajouter Webhook".
- Réglez la version de webhook sur la valeur par défaut "Legacy".
- Collez l'URL Webhook de votre intégration Botpress Aftership dans le champ
Webhook URL.
- Sauvegardez les paramètres de webhook .
Botpress Configuration
- Copiez et collez votre clé API de l'Aftership depuis la configuration de l'Aftership dans le champ
API Key.
- Copiez et collez votre
Webhook Secret de la configuration de l'Aftership dans le champ Secret.
## Ce que c'est
Une intégration tout simplement géniale pour connecter votre compte Aftership à votre bot Botpress . Suivez les expéditions en temps réel et informez les utilisateurs directement par le biais de votre bot lorsque des mises à jour ont lieu.
## Comment ça marche
Lors de l'activation de l'intégration, un abonnement Webhook est configuré pour votre compte Aftership à l'aide de la `API Key` fournie. Ce site webhook envoie des mises à jour à l'intégration chaque fois qu'il y a un changement significatif dans le statut de suivi d'un envoi.
L'action `Track Shipment` peut être utilisée pour initier le suivi d'un envoi. Elle nécessite un `Numéro de suivi` et utilise l'API d'Aftership pour récupérer et surveiller le statut de l'envoi, en intégrant un `Identifiant de conversation` unique dans les données de suivi. Cet identifiant est ensuite utilisé pour déclencher l'événement Aftership dans la conversation, ce qui permet à votre robot de répondre aux mises à jour de l'expédition.
`Conversation Id` est un identifiant unique pour chaque conversation. Vous pouvez passer `` dans ce champ pour intégrer votre identifiant. Lorsque vous recevez une mise à jour de l'Aftership, vous pouvez utiliser `` dans le champ `Conversation ID` des Options Avancées du `Aftership Event Trigger`. Cela dirige la mise à jour vers la conversation appropriée.
Vous pouvez voir le code d'intégration complet sur la page Git de Simply Great Bots : [Aftership Repo](https://github.com/SimplyGreatBots/aftership)
### Configuration de l'Aftership
#### Conditions préalables
Vous devez disposer d'un plan Aftership Pro ou supérieur pour recevoir les événements webhook à des fins de suivi.
#### Obtention de la clé API
1. Allez sur [Aftership Admin Dashboard] (https://admin.aftership.com/).
2. Naviguez vers `Developers` -> `API Keys`.
3. Cliquez sur `Create API Key`, nommez votre clé, et sélectionnez `Save`.
4. Copiez et collez votre clé API dans un endroit sûr, vous en aurez besoin lors de l'installation de Botpress .
#### Webhook et Secret
1. Naviguez vers [Tracking Dashboard -> Notifications -> Webhooks] (https://admin.aftership.com/notifications/webhooks#).
2. Copiez votre secret Webhook et collez-le dans un endroit sûr. Vous en aurez besoin lors de l'installation de Botpress .
3. Cliquez sur "Ajouter Webhook".
4. Réglez la version de webhook sur la valeur par défaut "Legacy".
5. Collez l'URL Webhook de votre intégration Botpress Aftership dans le champ `Webhook URL`.
6. Sauvegardez les paramètres de webhook .
### Botpress Configuration
1. Copiez et collez votre clé API de l'Aftership depuis la configuration de l'Aftership dans le champ `API Key`.
2. Copiez et collez votre `Webhook Secret` de la configuration de l'Aftership dans le champ `Secret`.
