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.
Utiliser un portail API Gateway
Une fois que vous avez publié votre portail, il est disponible sur le Web. Pour utiliser votre portail, copiez le nom de domaine par défaut du portail ou le nom de domaine et saisissez-le dans un navigateur. Si votre portail utilise un nom de domaine, le nom de domaine par défaut ne peut pas être utilisé pour accéder à votre portail.
Utiliser un portail
La procédure suivante montre comment accéder à un portail et utiliser Try it pour le point de terminaison REST d'un produit.
Pour utiliser un portail
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
Dans le volet de navigation principal, sélectionnez Portals.
Choisissez un portail.
Copiez le nom de domaine par défaut du portail ou le nom de domaine et saisissez-le dans un navigateur.
-
Sur la page d'accueil du portail, vous pouvez rechercher des produits du portail et découvrir des pages de produits. Utilisez la recherche en haut du portail pour rechercher l'ensemble du contenu de votre portail. Utilisez la barre de recherche située sous Produits pour rechercher des produits du portail.
Choisissez un produit de portail.
Choisissez un point de terminaison REST du produit.
Dans la fenêtre Try it, entrez les paramètres pour essayer d'appeler votre API.
Choisissez Try it. API Gateway invoquera votre API et affichera les résultats dans la fenêtre.
Résoudre les problèmes liés à votre portail
Vous trouverez ci-dessous des conseils de résolution des erreurs et des problèmes que vous pourriez rencontrer lors de l'utilisation d'un portail.
Impossible d'accéder au site Web du portail
Si vous recevez un message d'erreur indiquant que le site Web du portail n'est pas accessible, assurez-vous d'avoir publié votre portail. Si vous avez utilisé un nom de domaine, assurez-vous d'avoir ajouté l'enregistrement d'alias fourni par API Gateway pour diriger le trafic vers la CloudFront distribution de votre domaine personnalisé.
L'essai a échoué
Si vous ne parvenez pas à utiliser Try it pour le point de terminaison REST d'un produit, assurez-vous que l'état Try it est activéACTIVE. En outre, assurez-vous d'avoir saisi les bons paramètres pour appeler votre API.
Les pages n'apparaissent pas dans votre portail
Si vous avez créé une page de point de terminaison REST ou une page de produit et qu'elle n'est pas visible sur votre portail, assurez-vous que vos pages ne sont pas des brouillons. Pour vérifier cela, procédez comme suit :
Pour vérifier que vos pages ne figurent pas dans les brouillons
Connectez-vous à la console API Gateway à l'adresse https://console.aws.amazon.com/apigateway.
Dans le volet de navigation principal, sélectionnez Portal products.
Choisissez votre produit de portail.
Dans l'onglet Documentation, vérifiez que vos pages ne figurent pas dans la section Brouillon de documentation ou dans la section Brouillon de pages de référence d'API, mais dans les pages de documentation personnalisée ou les pages de référence d'API.
