> For the complete documentation index, see [llms.txt](https://docs.dydu.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dydu.ai/developpeurs/reference-api/import-export-du-bot.md).

# Import/Export du bot

Les API d'import/export du bot permettent de dupliquer un bot complet : par exemple pour copier un bot de production vers un bot de recette, ou pour passer d'un serveur SaaS à un serveur OnPremise.

## Avant de commencer

Vous avez besoin :

* de l'**identifiant du bot à exporter** (bot source) et de l'**identifiant du bot cible**. Le bot cible doit déjà exister : si besoin, créez-le avant l'import ;
* d'une **autorisation** sur le serveur du bot source et d'une autorisation sur le serveur du bot cible (voir [Authentification](https://docs.dydu.ai/developpeurs/reference-api/authentification)). Le compte utilisé doit être administrateur du bot.

Ces API se trouvent dans l'interface Swagger, catégorie **Bot data transfer** : dirigez-vous sur la page **Préférences > Api > Accès aux APIs** puis cliquez sur le lien proposé. L'interface Swagger est aussi accessible à l'adresse `https://<serveur>/servlet/api/doc3/index.html`.

La procédure se déroule en quatre étapes :

1. [Lancer l'export du bot source.](#id-1.-lancer-lexport)
2. [Vérifier que l'export est terminé.](#id-2.-verifier-que-lexport-est-termine)
3. [Lancer l'import sur le bot cible.](#id-3.-lancer-limport)
4. [Vérifier que l'import est terminé.](#id-4.-verifier-que-limport-est-termine)

Vous pouvez aussi [télécharger l'export](#telecharger-lexport) pour le conserver, mais ce n'est pas nécessaire pour l'import.

## 1. Lancer l'export

1. Cliquez sur **POST /bot/export/{botUUID}/{includeGallery}** (« Export bot data ») puis sur **Try it out**.
2. Remplissez les champs :
   * **botUUID** : identifiant du bot à exporter ;
   * **includeGallery** : `true` pour exporter aussi la galerie (recommandé), `false` sinon ;
   * **Authorization** : votre jeton sur le serveur du bot source ;
   * **DialogsPassword** : uniquement si l'option de chiffrement des conversations est activée dans le BMS, le mot de passe de déchiffrement. Sans lui, le contenu des conversations est masqué dans l'export.
3. Cliquez sur **Execute**.

Si l'export démarre, l'API renvoie le code **202**. L'en-tête `Location` de la réponse indique l'adresse à utiliser pour suivre l'export.

Si l'API renvoie le code **401** avec le message « Invalid authentication », vérifiez votre login et votre mot de passe, et que vous n'avez pas oublié « Basic » ou « Bearer » devant le jeton.

## 2. Vérifier que l'export est terminé

1. Cliquez sur **GET /bot/export/{botUUID}/status** (« Get export bot data status ») puis sur **Try it out**.
2. Remplissez les champs **botUUID** et **Authorization**.
3. Cliquez sur **Execute**.

Le champ `exportStatus` de la réponse indique l'état de l'export :

<table><thead><tr><th width="150">Valeur</th><th>Signification</th></tr></thead><tbody><tr><td><code>PROCESSING</code></td><td>L'export est en cours. Vérifiez à nouveau le statut un peu plus tard (après 5 à 10 minutes pour une base importante).</td></tr><tr><td><code>DONE</code></td><td>L'export est terminé.</td></tr><tr><td><code>ERROR</code></td><td>L'export a échoué. La réponse détaille la raison.</td></tr><tr><td><code>NOT_FOUND</code></td><td>Aucun export n'a été trouvé pour ce bot (code 404).</td></tr></tbody></table>

Une cause d'erreur fréquente est une configuration de chatbox qui n'est pas à jour. La réponse contient alors par exemple `"configurationsStatuses":{"5588419e-2fc7-4266-97aa-bd0982d2593c":"TO_FIX"}` : la configuration indiquée doit être corrigée avant de relancer l'export. L'export échoue dès qu'une configuration n'est pas dans l'état `STABLE`.

## 3. Lancer l'import

1. Cliquez sur **POST /bot/import/{botUUID}/fromurl** (« import bot data from url ») puis sur **Try it out**.
2. Remplissez les champs :
   * **botUUID** : identifiant du bot cible ;
   * **Authorization** : votre jeton sur le serveur du bot cible ;
   * **Url-Authorization** : votre jeton sur le serveur du bot source. Ce champ n'est utile que si l'URL est celle de l'API d'export ;
   * **body** : l'URL de l'export, par exemple `https://<serveur-source>/servlet/api/bot/exported/<botUUID-source>`, ou l'URL d'un fichier zip (par exemple « <https://www.monsite.com/exports/monbot.zip> »).
3. Cliquez sur **Execute**.

Si l'import démarre, l'API renvoie le code **202**.

{% hint style="info" %}
Vous pouvez aussi importer un fichier zip téléchargé au préalable avec **POST /bot/import/{botUUID}** (« import bot data »), en le sélectionnant dans le champ **file**.
{% endhint %}

{% hint style="warning" %}
L'import ne supprime pas les données déjà présentes sur le bot cible.
{% endhint %}

## 4. Vérifier que l'import est terminé

1. Cliquez sur **GET /bot/import/{botUUID}/status** (« Get import bot data status ») puis sur **Try it out**.
2. Remplissez les champs **botUUID** (bot cible) et **Authorization**.
3. Cliquez sur **Execute**.

Le champ `importStatus` de la réponse prend les mêmes valeurs que pour l'export (`PROCESSING`, `DONE`, `ERROR`). Lorsque l'import est terminé, la réponse contient aussi :

* `startDate` et `endDate` : dates de début et de fin de l'import ;
* `importedKnowledges` : résultat de l'import des connaissances ;
* `importedDialogs` : résultat de l'import des conversations ;
* `importedUsers` : résultat de l'import des utilisateurs.

En cas d'erreur, la réponse détaille la raison.

## Télécharger l'export

Cette étape est facultative.

1. Cliquez sur **GET /bot/exported/{botUUID}** (« Get exported bot data ») puis sur **Try it out**.
2. Remplissez les champs **botUUID** (bot source) et **Authorization**.
3. Cliquez sur **Execute**, puis sur **Download file** pour récupérer le fichier zip.

## Limites

L'export/import reprend notamment la base de connaissances, les configurations de chatbox, les utilisateurs, les langues et espaces de consultation, les réglages du bot, les compétences et opérateurs, les URL, les questionnaires et la galerie.

Deux points demandent une attention particulière :

* **Conversations** : seules les conversations des 31 derniers jours sont exportées.
* **Groupes de formulations du bot social ou de bots externes** (par exemple un métabot) : le lien avec ces groupes n'est pas toujours conservé, car ils sont référencés par des identifiants qui changent d'un serveur à l'autre. Vérifiez-les et corrigez-les à la main après l'import. Les groupes de formulations définis dans le bot sont bien importés.

## Suivre l'import dans la console

Une fois l'import terminé, ses traces sont disponibles dans la section **Console**, en affichant les messages de niveau **Info**.
