Skip to main content
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Émission de requêtes API

Contributeurs
PDF

L'interface utilisateur swagger fournit des détails complets et de la documentation pour chaque opération API.

Ce dont vous avez besoin

  • Vous devez être connecté à Grid Manager à l'aide d'un navigateur pris en charge.

  • Vous devez disposer d'autorisations d'accès spécifiques.

Important Toutes les opérations d'API que vous effectuez à l'aide de la page Web API Docs sont des opérations en direct. Veillez à ne pas créer, mettre à jour ou supprimer des données de configuration ou d'autres données par erreur.
Étapes

  1. Sélectionnez aide > Documentation API dans l'en-tête de Grid Manager.

  2. Sélectionnez l'opération souhaitée.

    Lorsque vous développez une opération API, vous pouvez voir les actions HTTP disponibles, telles QUE GET, PUT, UPDATE ou DELETE.

  3. Sélectionnez une action HTTP pour afficher les détails de la demande, notamment l'URL du noeud final, la liste de tous les paramètres obligatoires ou facultatifs, un exemple de l'organisme de demande (si nécessaire) et les réponses possibles.

    Exemple de l'interface utilisateur de swagger

  4. Déterminez si la demande nécessite des paramètres supplémentaires, tels qu'un ID de groupe ou d'utilisateur. Ensuite, obtenir ces valeurs. Vous devrez peut-être d'abord lancer une autre demande d'API pour obtenir les informations dont vous avez besoin.

  5. Déterminez si vous devez modifier l'exemple de corps de la demande. Si c'est le cas, vous pouvez cliquer sur modèle pour connaître les exigences de chaque champ.

  6. Cliquez sur essayez-le.

  7. Fournir tous les paramètres requis ou modifier le corps de la demande selon les besoins.

  8. Cliquez sur Exécuter.

  9. Vérifiez le code de réponse pour déterminer si la demande a réussi.