Test d'une API à l'aide de l'outil de test du portail de développeur

Vous pouvez tester le comportement d'une API sans avoir à écrire de code à l'aide de l'outil de test du portail de développeur . Vous fournissez les paramètres d'API nécessaires dans l'outil de test et cliquez sur Appeler pour afficher la réponse.

Avant de commencer

Pour utiliser l'outil de test du portail de développeur avec une API qui requiert un ID client d'application, vous devez d'abord effectuer les tâches suivantes:

A propos de cette tâche

L'outil de test du portail de développeur est un outil de test de document d'API interactif. Si l'opération que vous souhaitez tester ne nécessite pas d'ID client, vous pouvez utiliser l'outil de test Developer Portal sans qu'il soit nécessaire de vous connecter. Toutefois, si l'opération avec laquelle vous souhaitez interagir requiert un ID client, vous devez d'abord vous connecter au portail de développeur .

L'utilisation de l'outil de test du portail de développeur est soumise à la limite de débit qui est appliquée à une opération ou à un plan. Par exemple, si une opération a une limite de débit de dix demandes par minute et que vous appelez l'opération, le nombre de demandes exécutables devient neuf. Les limitations se déclenchent chaque fois que vous cliquez sur le bouton d'appel dans l'intervalle de temps en minutes. Cette mise en garde affecte le quota de l'application qui est sélectionnée pour être utilisée avec l'outil de test du portail de développeur , mais elle n'affecte pas le quota des autres applications qui utilisent la même opération ou le même plan.

Pour tester une API dans le portail de développeur, la case Autoriser cette API à être testée doit être cochée dans le gestionnaire d'API. Pour plus d'informations, voir Création de définitions d'API.

Restriction :
  • Il existe des mécanismes de sécurité qui vous empêchent d'utiliser l'outil de test Developer Portal pour tester un type d'octroi de code d'autorisation ou implicite dans une API de fournisseur OAuth. D'autres types d'accès dans la même API de fournisseur OAuth peuvent être testés. Si votre fournisseur OAuth permet à ces actions de fonctionner correctement à partir de l'outil de test, vous pouvez désactiver cette option. Pour plus d'informations, voir Désactivation des restrictions de l'outil de test.
  • Vous ne pouvez pas utiliser l'outil de test Developer Portal avec des applications suspendues.
  • Vous ne pouvez tester une API mise en application que si testable=true et que l'API existante implémente CORS et utilise HTTPS.
Remarque: les API GraphQL peuvent être testées à partir de l'interface utilisateur du portail de développeur . Toutefois, les méthodes d'authentification ne sont pas toutes prises en charge. Vous devez utiliser l'une des méthodes d'authentification suivantes :
  • Non sécurisé
  • ID client transmis dans l'en-tête
  • ID et valeur confidentielle du client transmis dans l'en-tête
En outre, les métriques cost ne sont pas prises en charge et les limites de débit spécifiques à GraphQL ne sont pas répertoriées dans les plans de produit.

Procédure

  1. Pour utiliser l'outil de test du portail de développeur avec une API qui ne nécessite pas l'ID client d'une application, procédez comme suit:
    1. Cliquez sur Produits d'API.
      Toutes les API pouvant être utilisées par les développeurs d'applications sont affichées.
    2. Cliquez sur le nom de l'API à tester.
    3. Sélectionnez une opération, puis sélectionnez Try It.
    4. Cliquez sur Essayer cette opération.
    5. Spécifiez les valeurs des en-têtes ou des paramètres requis.
    6. Si l'opération est sécurisée avec l'authentification de base, spécifiez les données d'authentification.
    7. Cliquez sur Envoyer la demande.
      Le résultat s'affiche dans la zone Corps de la réponse. Vous pouvez continuer à tester des valeurs de paramètre différentes si nécessaire.
      Remarque :

      La première fois que vous cliquez sur Essai, une erreur de sécurité peut s'afficher. Copiez l'URL de la zone d'URL de la demande, ouvrez-la dans une fenêtre de navigateur et acceptez le certificat de sécurité. Vous ne recevez alors plus d'erreur de sécurité.

      En outre, pour des raisons de performance, si le contenu est important, avec plus de 1500 éléments DOM mis en évidence, vous obtenez la réponse, mais elle n'est pas très bien imprimée.

  2. Pour utiliser l'outil de test du portail de développeur avec une API qui ne requiert pas l'ID client d'une application, procédez comme suit:
    1. Connectez-vous à Portail de développeur.
    2. Si vous ne l'avez pas déjà fait, vous devez créer une application pour tester une API qui nécessite un ID client. Pour plus d'informations, voir Enregistrement d'une application.
    3. Vérifiez que votre application est abonnée au plan contenant l'API à tester. Pour plus d'informations, voir Exploration des API et des produits dans le portail de développeur.
    4. Cliquez sur Produits d'API.
      Toutes les API pouvant être utilisées par les développeurs d'applications sont affichées.
    5. Cliquez sur le API à tester.
    6. Sélectionnez l'opération Provide credentials for Client ID (API Key) , puis sélectionnez Try It.
      La fenêtre Authentification par clé d'API s'affiche.
    7. Utilisez la liste déroulante Enregistrer une application afin de sélectionner un ID client pour sélectionner une application avec laquelle tester l'API.
    8. Cliquez sur Sauvegarder les données d'identification.
    9. Si une valeur confidentielle du client est requise, entrez la valeur dans la zone Valeur confidentielle du client .
    10. Recherchez l'opération que vous souhaitez tester, puis cliquez sur Try It.
    11. Fournissez les paramètres et valeurs requis.
    12. Si l'opération est sécurisée avec l'authentification de base, spécifiez les données d'authentification.
    13. Cliquez sur Envoyer.
      Le résultat s'affiche dans la section Réponse. Vous pouvez continuer à tester des valeurs de zone différentes si nécessaire.
      Remarque: La première fois que vous cliquez sur Appeler, une erreur de sécurité peut s'afficher. Cliquez sur le lien fourni pour accepter le certificat de sécurité. Vous ne recevez alors plus d'erreur de sécurité.