Guide de l'API Settings (API Swagger)

Cette fonctionnalité API peut être utilisée pour apporter des modifications à vos fichiers de configuration sans ouvrir l'interface graphique. Il est destiné à être utilisé avec des scripts externes, ce qui vous permet d'automatiser certains aspects des changements de configuration en fonction de vos propres signaux externes.

Vous pouvez accéder à l'API pour votre bot en visitant http://localhost:8081/swagger-ui.html.

Au chargement, vous verrez cet écran.

De la liste déroulante dans l'en-tête, vous avez deux options. Sélectionner settings-api (/v2/api-docs?group=settings-api) ou api (/v2/api-docs?group=api).

L'API Settings doit être validée à l'aide de la licence ProfitTrailer.

Cliquez sur le bouton Show/Hide ou List Operations pour afficher les options disponibles. Vous pouvez cliquer individuellement sur une opération pour la développer ou utiliser Expand Operations pour les développer tous.

  • - Supprimer une configuration nommée
  • - Lister toutes les configurations liées à la licence
  • - Changer la configuration active
  • - Affiche le contenu du fichier de configuration.
  • -

Delete

L'opération de suppression vous permet de supprimer une configuration basée sur son nom unique.

Paramètres:

  • configName - Le nom de la configuration que vous souhaitez supprimer
  • license - Votre licence ProfitTrailer

Remplissez les deux paramètres et cliquez sur pour supprimer la configuration choisie.


List

L'opération list liste toutes les configurations nommées connectées à la clé API par défaut utilisée.

Paramètres:

  • license - Votre licence ProfitTrailer

Remplissez la licence et cliquez pour voir la liste des configurations nommées.

Voici un exemple de la sortie:


Switch

L'opération switch passe d'une configuration nommée à une autre.

Paramètres:

  • configName - Le nom de la configuration que vous souhaitez activer
  • license - Votre licence ProfitTrailer

Remplissez les deux paramètres et cliquez faire de la configuration choisie la configuration active.


Load

L'opération de chargement vous permet d'afficher le contenu d'un fichier de configuration particulier.

Paramètres:

  • fileName - Le nom du fichier de configuration particulier
  • configName - Le nom de la configuration
  • license - Votre licence ProfitTrailer

Remplissez les trois paramètres et cliquez pour voir le fichier de configuration choisi.

Voici un exemple de la sortie:


Save

L'opération de sauvegarde vous permet d'écraser le contenu d'un fichier de configuration particulier. Il remplace le fichier entier.

Paramètres:

  • fileName - Le nom du fichier de configuration particulier
  • configName - Le nom de la configuration
  • saveData - Le contenu (paramètres) que vous souhaitez écraser avec le fichier.
  • license - Votre licence ProfitTrailer

Sélectionnez le nom de fichier désiré, remplissez les trois paramètres et cliquez pour remplacer le fichier de configuration.


L'API requiert server.api_token pour authentifier les appels.

Clique le Show/Hide Toggle ou List Operations pour afficher les options disponibles. Vous pouvez cliquer individuellement sur une opération pour la développer ou utiliser Expand Operations pour les développer tous.

  • fr/swagger_api.txt
  • Last modified: 8 months ago
  • by mopon