GraphQL UI Banana Cake Pop est une interface web puissante (Banana Cake Pop, Nitro) permettant d’explorer et d’interagir avec les API GraphQL. Elle permet aux utilisateurs de parcourir les schémas, d’écrire des requêtes et de les tester en temps réel – tout dans un environnement propre et convivial pour les développeurs.

URL de l’interface utilisateur GraphQL

Vous pouvez accéder à l’interface utilisateur GraphQL pour chaque environnement ici :

https://api.xoap.io/graphql/ui

Créer un nouveau document

Une fois l’interface utilisateur GraphQL chargée, cliquez sur “Créer un document” Fermer le bouton pour commencer.

Remarque : Si votre navigateur bloque les pop-ups, assurez-vous de les autoriser lorsque vous y êtes invité.

Configurer l'authentification

Avant de pouvoir utiliser l’API, vous devrez authentifier votre session.

Ouvrir les paramètres

Cliquez sur Paramètres Un icône dans le coin supérieur droit permet de configurer la connexion. Vous définirez à la fois l’extrémité de connexion et les informations d’authentification OAuth2.

Endpoint HTTP

Sous l'égide de “ Endpoint HTTP ” Dans la section « URL », saisissez l’URL correcte pour votre environnement :

https://api.xoap.io/graphql

Configuration de l’autorisation (OAuth2)

Sous l'égide de “ Autorisation ” Dans la section « Configuration », configurez les éléments suivants :

Champ	Valeur
Type	OAuth 2
Type de subvention	Code d'autorisation
URL d'autorisation	https://auth.xoap.io/auth/realms/my.xoap.io/protocol/openid-connect/auth
URL du token d'accès	https://auth.xoap.io/auth/realms/my.xoap.io/protocol/openid-connect/token
ID client	graphql
Utilisez PKCE	Oui
Méthode du Code Challenge	SHA-256
Réorienter l’URL	https://api.xoap.io/graphql/ui/
Champ d'application	Rôles du profil d’email – Origines web
Qualifications	Comme Header d’authentification de base (par défaut)

Authentification et application

1. Cliquez sur Fetch bouton.
2. Vous serez redirigé vers la page Page d’accès à XOAP.
3. Entrez vos informations d’identification.
4. Une fois authentifié, vous serez redirigé vers l’interface utilisateur GraphQL.
5. Cliquez sur “appliquer” Pour confirmer le token — il sera ajouté aux en-têtes de votre demande.

Ajouter la tête du locataire

Tout comme Swagger, cette API nécessite un ID du locataire à inclure dans les en-têtes.

Nous allons ensuite expliquer comment configurer cette balise en tête de page.

Ajouter la section « Titulaire »

Pour que vos appels API soient acceptés, vous devez inclure une adresse valide. ID du locataire dans les en-têtes de requête.

Cette étape est nécessaire — notre API utilise l’en-tête Tenant pour identifier le workspace qui effectue la requête. L’ID Tenant (également appelé ID Workspace dans certains cas) peut être obtenu à partir de app.xoap.io  tableau de bord comme montré ici :

Pour faire cela :

1. Scrollez jusqu'à en bas à gauche Zone des en-têtes HTTP de l’interface utilisateur GraphQL (en-dessous de la section « Token d’authentification »).
2. Cliquez sur “ En-tête ”.
3. Entrez les valeurs suivantes :

• NomLocation
• Valeur: Votre identifiant locataire

Cette en-tête est nécessaire pour que toutes les demandes authentifiées soient valides.

Une fois ajouté, l’en-tête « Tenant » sera inclus dans toutes les futures demandes GraphQL envoyées depuis l’interface utilisateur.

Charger le schéma

Une fois authentifié et les en-têtes configurés, vous devez Charger le schéma Ainsi, l’interface utilisateur peut fournir une assistance en matière de requête et une auto-complétion.

Vous pouvez le faire soit :

• Appuyez sur Ctrl + Alt + R
• En cliquant sur Recharger le schéma bouton dans l'interface utilisateur

Cela va récupérer l’ensemble du schéma du serveur et permettre des fonctionnalités telles que les suggestions de champs, l’information sur le type de données et la validation.

Après le chargement du schéma, essayez de saisir une requête — l’interface utilisateur fournira des suggestions en mode IntelliSense en fonction des types et des champs disponibles.

Exécutez une requête de test

Maintenant, vous êtes prêt à écrire et à exécuter des requêtes GraphQL.

• Utilisez le panneau d’édition pour saisir votre requête.
• Cliquez sur Exécuter () bouton ou appuyez sur Ctrl + Entrée pour l’exécuter.
• La réponse sera affichée dans le panneau à droite.

C’est un excellent moyen de :

• Explorons l’API sans avoir besoin d’accès au front-office
• Testez rapidement vos requêtes personnalisées ou résolvez vos problèmes
• Copier les requêtes fonctionnelles dans vos propres scripts ou outils

Vous avez maintenant terminé la configuration et testé avec succès l’API GraphQL XOAP.

Optionnel : Vous pouvez désormais combiner cela avec Swagger UI Pour une couverture complète de REST + GraphQL dans votre configuration de développement ou d’automatisation.

The post GraphQL UI appeared first on XOAP.

Swagger UI est un outil de documentation interactif pour les API REST. Il permet aux utilisateurs d’explorer les endpoints disponibles, de consulter les paramètres requis et de tester les appels API directement depuis le navigateur — sans écrire de code.
À quoi sert-il ?

• Visualisation des points d’accès API disponibles et de leurs structures de requête/réponse
• Comprendre comment appeler l’API (par exemple, les en-têtes requis, les paramètres de requête)
• Test des points d'extrémité en temps réel à l'aide de données réelles
• Obtenir des exemples de curl et de requête générés automatiquement

Pourquoi est-ce utile ?

• Pas besoin d’interface utilisateur : Les développeurs de back-end, les ingénieurs de QA ou les partenaires d’intégration peuvent tester les API même si l’interface utilisateur n’est pas encore disponible.
• Prêt pour le code : Vous pouvez tester une requête API dans Swagger, puis utiliser le même format de requête dans des outils comme Postman, curl ou des scripts (par exemple Python, PowerShell).

URL Swagger

Vous pouvez accéder à l’interface utilisateur Swagger ci-dessous :
https://api.xoap.io/swagger/index.html

Authentification dans l’interface Swagger UI

Une fois sur la page de l’interface utilisateur Swagger, suivez ces étapes pour authentifier et obtenir l’accès aux points d’extrémité protégés.

Sélectionnez le serveur d’API

En haut de l’interface Swagger, il y a un menu déroulant permettant de sélectionner le serveur d’API.
Choisissez l'option généralement appelée: API XOAP SSL

Cliquez sur Autoriser Un bouton situé en haut à droite de la page. Cela ouvre un popup contenant deux sections :

• Autorisation OAuth2
• En-tête Tenant (apiKey)

Sous l'égide de OAuth2 section :

1. Cliquez sur le bouton « Autoriser ».
2. Vous serez redirigé vers Page d’accès à XOAP.
3. Entrez votre nom d'utilisateur et mot de passe.
4. Une fois connecté avec succès, vous serez redirigé vers Swagger et pourrez En-tête d'autorisation sera automatiquement inclus dans toutes les demandes.

Sous la section OAuth2, il y a un champ permettant de définir l’en-tête Tenant :

• Insérez votre ID du locataire dans la zone d’entrée.
• Cliquez sur Autoriser Un bouton à côté de celui-ci.

Cette étape est nécessaire — notre API utilise l’en-tête Tenant pour identifier le workspace qui effectue la requête. L’ID Tenant (également appelé ID Workspace dans certains cas) peut être obtenu à partir de app.xoap.io  tableau de bord comme montré ici :

Une fois que les deux autorisations seront complétées :

• L'interface utilisateur apparaîtra des points de repère verts.
• Vous pouvez désormais cliquez sur “ Fermer ” sur le dialogue d’autorisation.
• Tous vos requêtes incluront désormais les en-têtes d’autorisation et de locataire corrects.

Vous êtes désormais prêt à commencer à utiliser l’API authentifiée dans Swagger !

Test de l’endpoint d’une API

Une fois authentifié, vous êtes prêt à commencer à explorer et à tester l’API. Trouvez tout point d’accès disponible dans la liste (par exemple, sous une étiquette comme « Devices », « Users », etc.), l’agrandissez et cliquez sur “ Essayez-le ” Button. Après avoir entré les paramètres requis (path, query ou body), cliquez sur “ Exécuter ”.

Swagger permettra de voir les deux demande envoyé et le réaction récupéré du serveur.

Ce que vous verrez :

• L'URL complète de la demande
• Headers (y compris Authorization et Tenant)
• Objet de la demande (si applicable)
• État de la réponse HTTP (par exemple, 200 OK, 401 Inconnu)
• Corps de la réponse JSON de l’API

C’est un excellent moyen de vérifier que vos identifiants fonctionnent et de comprendre la structure des demandes et des réponses avant de les intégrer dans un script ou une application.

Maintenant que vous avez testé l’API REST dans l’interface Swagger UI, vous êtes prêt à intégrer ces appels dans vos propres outils et workflows — que ce soit via Postman, curl ou des scripts personnalisés.

Cela permet aux utilisateurs avancés d’expérimenter, de tester et de créer leurs propres scripts d’automatisation ou d’intégration en utilisant les deux styles d’API selon les besoins.

The post API access documentation (Swagger) appeared first on XOAP.

Obtenez une liste de toutes les applications installées sur vos nœuds

La requête GraphQL suivante renvoie un liste de toutes les applications installé sur tous les nœuds (systèmes) de votre environnement :

query NodesWithSoftware($skip: Int = 0, $take: Int = 500) {
  configMngt_Nodes(skip: $skip, take: $take) {
    totalCount
    pageInfo { hasNextPage }
    items {
      id
      nodeName
      lastSystem {
        software {
          displayName
          displayVersion
          publisher
        }
      }
    }
  }}

Notes :
• Si vous gérez plus de 500 nœuds, augmentez la valeur de $prendre conformément.
• La pagination est supportée via sauter et hasNextPage.

Obtenez une liste de toutes les applications disponibles dans le Application Management module XOAP

Cela est utile pour Rapports, validation, ou des tâches d’automatisation impliquant Définitions d'application. Vous pouvez utiliser la requête GraphQL suivante pour cela :

query ListAllApplications($skip: Int = 0, $take: Int = 100) {
  appMngt_Applications(skip: $skip, take: $take) {
    totalCount
    pageInfo { aNextPage }
    articles {
      id
      Nom
      fournisseur
      version
      packageName
      Operating System
      architecture
      langue
      createdAt
      Date de modification
    }
  }
}

Cette requête renvoie également Les métadonnées Pour toutes les applications, y compris les détails tels que le fournisseur, la version, le système d’exploitation cible et l’architecture.

Notes :
• Vous pouvez augmenter le $prendre valeur si plus de 100 demandes sont attendues.
• Utilisez le hasNextPage ajouter une fonction de pagination si nécessaire.

Obtenez une liste de tous les systèmes d'un fabricant de matériel informatique spécifique

Cette requête vous permet de récupérer tous les nœuds d'un fabricant spécifique (Par exemple, Lenovo) enregistré dans votre espace de travail XOAP.

Cela peut être utile pour Audits d’inventaire, Gestion du cycle de vie du matériel, ou activités de patchage et de conformité spécifiques au fournisseur. Utilisez la requête GraphQL suivante :

query LenovoFlatNodes($skip: Int = 0, $take: Int = 5) {
  configMngt_FlatNodes(
    skip: $skip
    take: $take
    where: { csManufacturer: { eq: "LENOVO" } }
    order: [{ nodeName: ASC }]
  ) {
    totalCount
    pageInfo { hasNextPage }
    items {
      id
      nodeName
      csManufacturer
      csModel
      osName
      osVersion
    }
  }
}

Notes :
• Le nom du fabricant est sensible aux majuscules et aux minuscules.
• Pour filtrer par un autre fournisseur (par exemple HP ou DELL), modifiez la valeur de csFabricant: { eq: "..." } conformément.
• Augmenter $prendre value pour récupérer plus d'enregistrements ou pour implémenter la pagination en utilisant la hasNextPage champ.
• Cet exemple classe les résultats selon nodeName Dans l'ordre croissant.

Comment savoir ce que vous pouvez interroger

XOAP collecte une quantité considérable de données provenant de vos nœuds, ainsi que des métadonnées supplémentaires concernant votre espace de travail. Avec un ensemble de données aussi important, il peut être difficile de déterminer quels champs sont disponibles pour une requête.

La meilleure façon d’explorer les options de requête disponibles est de consulter la SDL (Langage de définition de schéma). Le SDL fournit un aperçu complet de tous les objets, champs et types pouvant être consultés via GraphQL.

En inspectant le SDL, vous pouvez :

• Découvrez toutes les structures de données disponibles
• Déterminer les relations entre les entités
• Comprenez le plein potentiel des requêtes GraphQL dans XOAP

Cette approche vous permet de ne pas être limité par des requêtes prédéfinies et de tirer pleinement parti des données collectées dans votre environnement.

Vous avez besoin de plus de questions ou souhaitez-vous en ajouter de nouvelles ?

Le github.com/xoap-io/queries Le dépôt est à vous Une collection de commandes GraphQL réutilisables à base de go Conçue pour la gestion matérielle et applicative dans le cadre de XOAP et des plateformes associées.

Comment l’utiliser :

1. Naviguez jusqu’à applications/ ou matériel informatique/ des dossiers.
2. Copiez les informations pertinentes .graphql enregistrez-le dans votre API ou votre client GraphQL.
3. Ajustez les paramètres selon les besoins pour adapter les paramètres à votre environnement.

Sous la licence MIT et avec zéro étoile ou aucun fork jusqu’à présent, ce projet continue de se développer. Nous vous invitons chaleureusement à apporter votre contribution — que ce soit en soumettant des problèmes, en améliorant des requêtes ou en ouvrant des demandes de pull pour enrichir cette ressource partagée. Ensemble, faisons de l’envergure !

The post What you can do with GraphQL appeared first on XOAP.