1.
But et parcours de la formation
Cette formation a pour objectif de permettre aux participants de comprendre et de maîtriser
l'architecture GraphQL appliquée à Sage X3. Elle est conçue pour des développeurs et des
administrateurs techniques souhaitant utiliser efficacement Sage X3 Builder pour modéliser et
exposer les données clés de l'ERP. Le parcours de la formation est divisé en plusieurs modules,
couvrant à la fois la théorie et la pratique, avec des travaux sur une machine virtuelle Sage X3 V12.
Premièrement je vais vous présenter le parcours de formation :
Parcours de la formation :
1. Introduction générale :
C’est quoi graph QL dans sage X3 ?
Prérequis
Architecture
2. X3 services
Introduction à X3 services
Installation X3 services
3. Introduction à Sage X3 Builder et à l'API GraphQL: Présentation de l'architecture GraphQL dans
Sage X3. L'accent sera mis sur sa capacité à résoudre les problèmes de sur-extraction de données
(over-fetching) des API REST traditionnelles, grâce à un point d'accès unique.
4. Exploration des fonctions API dans X3: Définition des modèles de données, des nœuds et des
dictionnaires de liaison en utilisant X3 Builder. Ce module couvrira l'un des "quatre piliers" de la
plateforme Sage : la connectivité.
5. Installation et configuration du Dev Pack: Mise en place de l'environnement de développement,
y compris la configuration de [Link] et de VS Code, qui sont les outils officiellement supportés
pour le développement sur Sage X3.
6. Création d'un package personnalisé: Création de code d'activité et ajout de champs
personnalisés sur une entité standard (ex. : Produits). L'approche par packages permet une
organisation modulaire du code au sein de X3.
7. Développement d'opérations personnalisées: Création de modèles d'importation JSON et
paramétrage des opérations API dans GESAPIOPE. Un cas concret sera la création d'une mutation
GraphQL pour un produit permettant la modification depuis une application externe.
8. Utilisation de scripts 4GL dans les mutations: Création de sous-programmes pour les opérations
de création, mise à jour et suppression, et leur appel depuis GraphQL.
9. Test et validation des développements: Utilisation d'un client API (comme Postman ou Bruno)
pour l'introspection et les tests. Ce module inclura également les bonnes pratiques de sécurité,
comme la définition d'une profondeur maximale pour les requêtes et l'application d'une limite de
débit.
10. Établir une connexion entre Shopify et X3 via GraphQL: Étude de cas sur l'intégration d'un e-
commerce et d'un ERP via l'API. Cette partie concrétise l'un des principaux bénéfices de cette
technologie, l'automatisation des échanges de données entre plateformes.
1
Résultats attendus :
À l'issue de ce parcours, les participants seront capables de :
Créer, configurer et sécuriser des API GraphQL dans Sage X3.
Connecter Sage X3 à des plateformes externes pour automatiser les flux de données.
Optimiser les appels API pour améliorer les performances et réduire la latence.
Documenter et maintenir leurs développements grâce à l'introspection GraphQL.
Intro
Ce premier chapitre a pour objectif de poser les bases de la formation en définissant :
Ce qu'est GraphQL et en introduisant son application spécifique dans l'environnement de Sage X3.
On va commencer par répondre à la question C’est quoi GraphQL? 🧐
Selon la définition officielle, GraphQL est un langage de requête pour les API et un runtime côté
serveur qui exécute des requêtes sur un schéma fortement typé que vous définissez, afin que les
clients obtiennent exactement les données dont ils ont besoin ; conçu chez Facebook en 2012, open
source depuis 2015, aujourd’hui gouverné par la GraphQL Foundation.
Maintenant C’est quoi une API GraphQL dans Sage X3 ? 🧐
Dans Sage X3, l’API GraphQL est l’interface web exposée par Sage X3 Services. Elle publie un schéma
métier accessible via un point d’entrée unique : les clients envoient des queries (lecture) et des
mutations (écriture), pour recevoir uniquement les champs demandés.
2
L'API GraphQL est un outil qui permet de requêter de manière efficace et flexible les données de
l'ERP Sage X3. Plutôt que d'utiliser de multiples points de terminaison (endpoints) comme c'est le cas
avec REST, l'API GraphQL de Sage X3 utilise un seul point d'accès pour toutes les requêtes, offrant
ainsi un contrôle total au développeur sur les données dont il a besoin. Le but principal de cette API
est de faciliter l'intégration de Sage X3 avec des plateformes externes, comme les site e-commerce et
les applications mobiles .
Architecture GraphQL dans Sage X3 :
L’API GraphQL est fournie et opérée nativement au sein de Sage X3 via Sage X3 Services : aucune
passerelle tierce à déployer côté X3. Elle s’appuie sur les métadonnées et objets métier X3 et expose
un endpoint unique (/graphql) sécurisé, prêt à être consommé par des applications tierces.
Nous reviendrons juste après sur le composant indispensable Sage X3 Services et son installation.
Un explorateur GraphQL est intégré à Sage X3 Services c’est le Graph API Sandbox. Il permet de :
Parcourir le schéma (types, Query/Mutation) grâce à l’introspection.
Bénéficier de l’auto-complétion, de l’aide en ligne et d’un historique des requêtes.
Exécuter queries/mutations, passer des variables, ajouter des en-têtes (auth, contexte), et
voir la réponse JSON immédiatement.
Avantage
L'API GraphQL dans Sage X3 représente une évolution majeure par rapport aux approches
d'intégration traditionnelles comme les services web REST .
Au lieu d'avoir de multiples points de terminaison (end points) pour accéder à des ressources
spécifiques (par exemple, /produits, /clients, /commandes), GraphQL centralise toutes les opérations
sur un seul point d'accès.
Cette architecture offre aux développeurs un contrôle total sur les données. Vous pouvez demander
précisément ce dont vous avez besoin, rien de plus. Cela résout les problèmes de sur-extraction de
données (over-fetching) et de sous-extraction de données (under-fetching), ce qui permet de réduire
considérablement la latence et d'optimiser les performances des applications clientes.
De plus, GraphQL intègre une fonctionnalité d'introspection qui permet à l'API de se décrire elle-
même, offrant aux développeurs un gain de productivité énorme.
L'objectif principal de cette API est de faciliter les intégrations en temps réel et de simplifier la
connexion de Sage X3 à des plateformes externes comme des sites e-commerce (par exemple,
Shopify).
3
Architecture (sans sageX3 builder)
Dans Sage X3, l’API GraphQL est exposée par X3 Services.
Architecture (avec sageX3 builder)