Développement de modules

StockTicket permet aux développeurs de créer des modules pour étendre les fonctionnalités de la plateforme.

Les modules peuvent être utilisés pour ajouter de nouvelles fonctionnalités, intégrer des services externes, ou personnaliser l'expérience utilisateur.

Etapes de développement

Pour développer un module, il est nécessaire de suivre les étapes suivantes:

• Construire le module dans son environnement de développement local.
• Déployer le module sur un environnement de test ou de production et le rendre accessible par StockTicket via une url sécurisée https://.

• Déclarer le module dans l'interface StockTicket, en fournissant notamment l'url de base du module https:// sur laquelle StockTicket pourra solliciter le module lorsque cela est nécessaire.
  Tip: Cette action peut se faire par le biais de l'interface graphique de back-office StockTicket, ou par le biais de l'API d'administration StockTicket.

• Dans le cas d'un module fournissant des interfaces graphiques nécessitant une intégration dans l'interface utilisateur du back-office StockTicket, il est nécessaire de déclarer les intégrations souhaitées (écrans, actions, formulaires, etc.) via l'API StockTicket dédiée aux intégrations (voir Déclarer une intégration).

• Demander la validation du module par l'équipe StockTicket ...

Utilisation des APIs StockTicket dans vos modules

Les modules peuvent interagir avec StockTicket en utilisant les API StockTicket.
Pour cela, il est nécessaire d'inclure une clé d'API dans les requêtes effectuées vers les API StockTicket.
En fonction de vos besoins, vous serez amenés à effectuer des appels en fournissant une clé d'API différente:
- si votre module doit interagir avec StockTicket en tant que module, indifféremment de l'utilisateur connecté (ex: sauvegarder des données de configuration globale de votre instance de module, etc.), vous devez utiliser la clé d'API de votre module/instance (voir Authentification dans les appels d'API.)
- si votre module doit interagir avec StockTicket en tant qu'utilisateur de la plateforme dans le contexte d'une integration visuelle de votre module, et que votre module doit agir "pour le compte" de l'utilisateur connecté, vous devez récupérer le token fourni dans l'url par StockTicket et l'utiliser en tant que clé pour les requêtes d'API effectuées dans ce contexte.
- si votre module doit interagir avec StockTicket en tant qu'utilisateur de la plateforme dans un contexte non visuel, vous devez simplement utiliser la clé personnelle de l'utilisateur (voir Authentification) dans les appels d'API.