Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail
Utilisez try it pour permettre à un utilisateur d'API d'appeler le point de terminaison de votre produit depuis votre portail. Lorsqu'un utilisateur de l'API utilise Try it, il saisit les paramètres de demande de méthode et invoque le point de terminaison de votre produit. API Gateway appelle ensuite votre API sur l'Internet public et renvoie la réponse dans la fenêtre d'essai. Vous pouvez utiliser une page de produit personnalisée pour fournir des informations supplémentaires sur les paramètres requis pour accéder à votre API.
API Gateway applique les limites suivantes pour protéger votre APIs :
API Gateway n'autorise que 3 requêtes par seconde adressées à votre API.
-
API Gateway utilise un délai d'expiration intégré de 29 000 ms. Votre API actuelle a peut-être un délai d'expiration plus élevé, mais API Gateway n'applique pas ce délai lorsqu'un client essaie de l'utiliser.
-
API Gateway limite la charge utile de réponse à 6 Mo.
Considérations
Les considérations suivantes peuvent avoir une incidence sur la façon dont vous utilisez Try it :
-
Essayez, il n'est pas pris en charge lorsque vous prévisualisez un portail.
-
Essayez qu'il n'est pas pris en charge pour le REST APIs avec les fonctionnalités suivantes :
Privé APIs
APIs qui utilisent le protocole TLS mutuel
APIs qui utilisent des certificats SSL privés ou auto-signés
En tant que propriétaire du portail, vous êtes responsable de la communication avec les utilisateurs de votre API. La raison pour laquelle le bouton « essayer » n'existe pas pour les applications APIs REST non prises en charge. API Gateway ne vous explique pas cela.
Activez Essayez-le pour un point de terminaison REST du produit
La procédure suivante indique comment activer Try it pour un point de terminaison de produit.
Pour savoir comment utiliser Try it in a portal, voirUtiliser un portail API Gateway.
Activez Essayez-le pour un point de terminaison REST du produit
Dans le volet de navigation principal, sélectionnez Portal products.
Choisissez un produit.
Dans l'onglet Documentation, sous les pages de référence de l'API, choisissez le nom d'un point de terminaison REST du produit, tel que /dogs - GET.
Choisissez Modifier la page.
Pour permettre aux clients d'invoquer votre API sur votre portail, sélectionnez la fonctionnalité Essayer.
Sélectionnez Enregistrer les modifications.
Vous devez republier tous les portails qui utilisent ce produit de portail pour que les modifications prennent effet.
