Si les API REST sont utilisées depuis longtemps pour les intégrations, GraphQL gagne rapidement du terrain du fait de sa souplesse et de son efficacité. Vous pouvez utiliser les fonctionnalités du créateur d’intégration pour l’intégration avec les API GraphQL. Vous pouvez profiter des fonctionnalités clés de GraphQL, comme demander uniquement les données dont vous avez besoin ou gérer facilement les requêtes complexes.
Dans cet article, nous allons voir comment configurer une demande GraphQL avec le créateur d’intégration, de la compréhension du schéma GraphQL à la création de requêtes et l’intégration de réponses à vos conversations.
Pour configurer une demande GraphQL
- Recherchez l’URL de point de terminaison GraphQL, qui est généralement fourni dans la documentation de l’API (par exemple, https://api.example.com/graphql ou pour Shopify : https://{{storeName}}.myshopify.com/admin/api/2023-04/graphql.json).
- Ajoutez-la à l’interface du créateur d’intégration.
- Allez à Environnements et sélectionnez le type de méthode POST (si vous faites une demande de données).
- Ajoutez votre point de terminaison GraphQL à l’entrée de l’URL.
- Sélectionnez votre méthode d’authentification (si nécessaire).
- Si besoin est, ajoutez vos identifiants aux en-têtes. Par exemple, s’il s’agit d’une intégration Shopify, elle ressemblera à ce qui suit :
- Prenez le temps de comprendre le schéma GraphQL pour sélectionner les données que vous voulez que le serveur renvoie.
- Obtenez le schéma du serveur GraphQL.
Il définit les requêtes, les mutations et les types disponibles. Utilisez des outils comme Postman, GraphiQL ou Apollo Explorer pour inspecter le schéma, et tester et affiner la requête.
Nous vous conseillons d’obtenir la requête de Postman en allant à l’onglet Snippet de code et en recherchant les données où vous voyez un objet avec la clé « query ». Copiez l’objet pour l’utiliser lors de l’étape suivante.
- Dans l’onglet Corps, ajoutez la requête GraphQL en spécifiant les données dont vous avez besoin ou l’action que vous voulez effectuer (si vous faites une demande de mutation pour modifier, créer, mettre à jour ou supprimer des données).
Vous devez utiliser le format JSON.
Exemple de requête :
```{"query":"{\n __type(name: \"Order\") {\n name,\n fields {\n name\n type {\n name\n kind\n }\n }\n }\n}","variables":{}}```
- Allez au scénario de réussite pour ajouter vos paramètres de session.
- En utilisant JSONata, rédigez vos requêtes pour accéder et transformer (si besoin est) les données dans la réponse. Consultez l’illustration ci-dessous pour voir un exemple :
