Configuration de modules

Chaque instance de module déployée dispose d'un espace de stockage dédié pour persister sa configuration. Cet espace vous permet de sauvegarder les paramètres spécifiques à votre instance de module sans avoir à gérer vous-même un espace de stockage externe.

Dans quels cas, enregistrer la configuration d'une instance de module peut être utile ?

Sauvegarder la configuration de son instance de module peut être utile pour stocker :

• Les paramètres de connexion à des services externes (URLs d'API, identifiants de connexion, etc.)
• Les préférences de fonctionnement de votre module (intervalles de synchronisation, seuils d'alerte, etc.)
• Les options d'affichage configurées par l'administrateur du module
• Toute autre donnée nécessaire au fonctionnement de votre instance de module

Comment ça fonctionne ?

StockTicket met à disposition deux API simples pour gérer la configuration de votre instance de module. Ce sont des méthodes de l'API client StockTicket, accessibles en fournissant une clé de module.

Récupérer la configuration (Settings/GetSettings)
Permet de lire la configuration actuellement enregistrée pour votre instance de module. Si aucune configuration n'a encore été sauvegardée, cette API retournera une erreur que vous devrez gérer en initialisant des valeurs par défaut.

Enregistrer la configuration (Settings/SetSettings)
Permet de sauvegarder ou mettre à jour la configuration de votre instance de module. L'ancienne configuration est entièrement remplacée par la nouvelle.

Documentation des méthodes

Pour plus de détails techniques sur les endpoints (paramètres, codes de retour, formats exacts), consultez la documentation dynamique de ces méthodes dans Swagger UI

Structure de la configuration

La configuration sauvegardée doit être au format JSON. Vous êtes entièrement libre de définir la structure JSON qui correspond à vos besoins. StockTicket n'impose aucun format particulier : vous définissez vos propres propriétés, objets et tableaux selon l'architecture qui convient à votre module.

Limitation importante : La taille totale de votre configuration ne peut pas dépasser 1 Mo (environ 1 million de caractères).

Authentification

Pour accéder à ces API, utilisez la clé d'API de votre module/instance.
Cette clé vous est fournie lors de la déclaration de votre module dans StockTicket.
Elle permet d'identifier votre instance de module et d'accéder uniquement à son espace de configuration dédié (consulter la rubrique Authentification).

Documentation des méthodes

Pour plus de détails techniques sur les endpoints (paramètres, codes de retour, formats exacts), consultez la documentation dynamique de ces méthodes dans Swagger UI

Cas d'usage typique

1. Au démarrage de votre module, appelez GetSettings pour récupérer la configuration
2. Si aucune configuration n'existe, initialisez des valeurs par défaut et sauvegardez-les avec SetSettings
3. Lorsque l'administrateur modifie des paramètres via votre interface, appelez SetSettings pour persister les changements
4. Lors des traitements, utilisez la configuration chargée en mémoire plutôt que d'appeler systématiquement GetSettings

Conseils pratiques

• Validez toujours la structure de la configuration récupérée avant de l'utiliser (présence des propriétés attendues, types de données corrects)
• Prévoyez des valeurs par défaut cohérentes pour tous vos paramètres de configuration
• Ne stockez pas de données sensibles en clair (mots de passe, tokens secrets) : privilégiez des mécanismes de chiffrement
• Documentez la structure de votre configuration pour faciliter le débogage et les évolutions futures
• Incluez un numéro de version dans votre configuration pour gérer les migrations lors des mises à jour de votre module