> 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/acces-aux-apis.md).

# Accès aux APIS

La page **Préférences > Api > Accès aux APIs** regroupe les informations nécessaires pour appeler les API de votre bot. Elle est réservée aux administrateurs.

Vous y trouverez :

* l'**identifiant de votre bot** (botUUID), demandé par la plupart des API ;
* l'**identifiant de votre compte** (accountUUID), demandé notamment pour l'[import d'une base de connaissances](https://docs.dydu.ai/developpeurs/reference-api/import-export-base-de-connaissances#importer-une-base-de-connaissances) ;
* un **jeton d'authentification** ;
* le **lien vers l'interface Swagger**, qui permet de consulter et de tester les API.

Pour construire vous-même l'en-tête `Authorization`, voir [Authentification](https://docs.dydu.ai/developpeurs/reference-api/authentification).

## Interface Swagger

Cliquez sur le lien affiché sur la page **Accès aux APIs** pour ouvrir l'interface Swagger. Les API y sont regroupées par catégorie. Pour tester une API :

1. Cliquez sur la catégorie, puis sur l'API.
2. Cliquez sur **Try it out**.
3. Remplissez les champs, dont **Authorization** (voir [Authentification](https://docs.dydu.ai/developpeurs/reference-api/authentification)).
4. Cliquez sur **Execute**.

### Catégories disponibles

| Catégorie                            | À quoi elle sert                                                                                                                                                                            |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Account**                          | Obtenir la liste des bots auxquels un utilisateur a accès, et obtenir un jeton d'authentification (`POST /authentication/token`).                                                           |
| **Account preferences**              | Consulter, ajouter ou supprimer les préférences d'un compte utilisateur.                                                                                                                    |
| **Bot data transfer**                | Exporter et importer un bot complet ou sa galerie d'images. Voir [Import/Export du bot](https://docs.dydu.ai/developpeurs/reference-api/import-export-du-bot).                              |
| **Bot dialogs**                      | Exporter les conversations, consulter ou supprimer le résumé d'une conversation, gérer les tickets.                                                                                         |
| **Bot knowledge base**               | Exporter, importer ou supprimer une base de connaissances. Voir [Import/Export Base de connaissances](https://docs.dydu.ai/developpeurs/reference-api/import-export-base-de-connaissances). |
| **Bot log explicit**                 | Gérer les logs.                                                                                                                                                                             |
| **Bot matching groups**              | Obtenir les groupes de formulations du bot.                                                                                                                                                 |
| **Bot OIDC filters**                 | Gérer les filtres OIDC du bot.                                                                                                                                                              |
| **Bot preferences**                  | Consulter, ajouter ou supprimer les préférences du bot. Voir Modifier une préférence du bot.                                                                                                |
| **Bot surveys**                      | Gérer les questionnaires (création, récupération…).                                                                                                                                         |
| **Chat**                             | Faire dialoguer le bot. Voir [Boîte de dialogue API](https://docs.dydu.ai/developpeurs/reference-api/boite-de-dialogue-api).                                                                |
| **Chatboxes Saml2 service provider** | Gérer l'authentification SAML des chatbox.                                                                                                                                                  |
| **Dialogs Bot preferences**          | Gérer les préférences du bot liées aux conversations.                                                                                                                                       |
| **External Livechat**                | Déconnecter une conversation d'un livechat externe.                                                                                                                                         |
| **Livechat competencies**            | Gérer les compétences livechat (ajout d'une compétence à un compte, suppression…).                                                                                                          |
| **Livechat operators availability**  | Connaître la disponibilité des opérateurs.                                                                                                                                                  |
| **LLM**                              | Gérer les fonctions LLM du bot.                                                                                                                                                             |
| **SAML**                             | Synchroniser la configuration SAML.                                                                                                                                                         |
| **Server BO users**                  | Modifier le type d'un compte existant (Admin, Linguist, None, All) ou supprimer un compte.                                                                                                  |
| **Server status**                    | Obtenir l'état du serveur. Voir [API de statut du serveur](https://docs.dydu.ai/developpeurs/reference-api/api-de-statut-du-serveur).                                                       |
| **Server Who am I**                  | Récupérer les informations reçues par le serveur pour votre requête.                                                                                                                        |

{% hint style="info" %}
Les catégories **Livechat** n'apparaissent que si le livechat est activé.
{% endhint %}

## Modifier une préférence du bot

Certains réglages ne sont pas disponibles dans les écrans du BMS : ils se font en ajoutant ou en modifiant une préférence du bot.

1. Dirigez-vous sur la page **Préférences > Api > Accès aux APIs** puis cliquez sur le lien proposé.
2. Cliquez sur **Bot preferences**.
3. Cliquez sur **PUT /preferences/bot/{botUUID}/{name}/{value}** puis sur **Try it out**.
4. Remplissez les champs :
   * **botUUID** : identifiant de votre bot ;
   * **name** : nom de la préférence (voir le tableau ci-dessous) ;
   * **value** : valeur de la préférence ;
   * **Authorization** : votre jeton.
5. Cliquez sur **Execute**.

| Préférence (name)                 | Valeur (value)                         | Effet                                                                                                                                |
| --------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `chatbox.auth.saml.menu.enabled`  | `true`                                 | Affiche le menu SAML. L'authentification SAML doit ensuite être configurée : voir [SAML 2](https://docs.dydu.ai/preferences/saml-2). |
| `livechat.createmonitoreddialogs` | `true`                                 | Active les conversations monitorées.                                                                                                 |
| `bot.servicename`                 | Nom de votre service                   | Remplace « dydu » par le nom de votre service dans les mails envoyés par le bot, dont le mail RGPD.                                  |
| `bot.no.group.uuid`               | UUID du groupe de formulations **Non** | Permet au bot d'utiliser le groupe **Non** du bot social. Voir ci-dessous.                                                           |

{% hint style="info" %}
Pour consulter une préférence, utilisez **GET /preferences/bot/{botUUID}/{name}**. La recherche est partielle : le nom « hello » renvoie aussi la préférence « helloWorld ».
{% endhint %}

### Utiliser le groupe de formulations Non du bot social

Dans la plupart des cas, cette configuration n'est pas nécessaire.

Le groupe de formulations **Non** du bot social permet de bien gérer la confirmation lorsque l'utilisateur souhaite quitter, ou non, une connaissance **Slot**. Sans lui, votre bot peut abandonner la connaissance **Slot** alors que l'utilisateur ne le souhaitait pas.

1. Dirigez-vous sur la page **Contenus > Groupes de formulations**.
2. Cliquez sur le groupe **Social** pour faire défiler les groupes, puis cliquez sur le groupe **Non**.
3. Cliquez sur **Dépendances**.
4. Récupérez l'UUID dans l'URL : c'est la suite de chiffres et de lettres après **group=**.

> Exemple : pour l'URL « <https://app1.earth.doyoudreamup.com/website/knowledges/groupgraph?group=12345a67-bc89-12d3-4efg-hi56789123j0> », l'UUID est « 12345a67-bc89-12d3-4efg-hi56789123j0 ».

5. Suivez la procédure [Modifier une préférence du bot](#modifier-une-preference-du-bot) avec **name** : `bot.no.group.uuid` et **value** : l'UUID récupéré à l'étape 4.
