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.
# Portails API Gateway
Vous pouvez utiliser un portail API Gateway pour partager votre documentation APIs et celle des API avec les utilisateurs d'API sur une page Web. Un portail contient un ensemble de *produits de portail*. Chaque produit de portail est un regroupement logique de REST APIs et contient la documentation que vous créez et publiez pour vos utilisateurs d'API. Les pages de produits d'un portail contiennent la documentation personnalisée au niveau du produit du portail. Les *pages de point de terminaison REST du produit* contiennent la documentation de chacun des REST APIs ainsi que le chemin, la méthode et l'étape d'une API REST. La combinaison des pages produit et des pages de point de terminaison REST du produit fournit la documentation complète permettant aux utilisateurs d'API d'apprendre comment commencer à utiliser votre REST APIs.
Utilisez un portail pour effectuer les opérations suivantes :
+ Utilisez API Gateway pour l'ensemble du cycle de vie de vos API, de leur création APIs à leur documentation et à leur distribution.
+ Partagez les produits du portail entre différents AWS comptes.
+ Personnalisez et partagez un emplacement central pour les produits de votre portail et fournissez des pages de produits.
## Considérations
Les considérations suivantes peuvent avoir un impact sur votre utilisation des portails API Gateway :
+ Vous ne pouvez créer des portails que pour partager REST APIs.
+ Les portails sont créés au niveau de la AWS région. Votre portail ne peut contenir que des fichiers REST situés dans la même région APIs que celle dans laquelle vous avez créé le portail.
+ Vous ne pouvez utiliser le AWS Management Console AWS CLI, ou que AWS SDKs pour créer et partager vos portails.
+ Vous ne pouvez contrôler l'accès à votre portail qu'à l'aide des groupes d'utilisateurs Amazon Cognito. Les utilisateurs de votre portail peuvent soit se connecter directement par le biais d'un groupe d'utilisateurs, soit se fédérer via un fournisseur d'identité (IdP) tiers. Si vous utilisez un groupe d'utilisateurs Amazon Cognito, vous ne pouvez pas définir de secret client pour votre groupe d'utilisateurs. Pour plus d'informations, consultez la section [Groupes d'utilisateurs Amazon Cognito](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools.html).
# Produits du portail dans API Gateway
Un *produit de portail* représente un service ou une fonctionnalité que vous souhaitez partager. Le produit de votre portail est un ensemble de points de terminaison REST et de pages de produits. Les *points de terminaison REST du produit* sont les points d'accès à votre produit de portail. Ils comprennent le chemin et la méthode d'une API REST ainsi que l'étape sur laquelle elle est déployée. Les *pages de produits* sont des documents que vous fournissez pour expliquer comment les utilisateurs d'API peuvent utiliser les points de terminaison de vos produits. Un produit de portail peut contenir l'intégralité de la `Prod` phase sous la forme d'un ensemble de points de terminaison REST du produit ou simplement la `GET /pets` ressource déployée sur la `Prod` scène sous la forme d'un point de terminaison REST de produit unique.
Le produit de votre portail est personnalisable. Vous pouvez ajouter une documentation personnalisée, renommer les points de terminaison REST du produit, réorganiser l'ordre d'affichage, ajouter de nouvelles sections et partager des produits entre comptes. AWS Pour que les modifications que vous apportez à votre produit de portail prennent effet, vous devez republier tous les portails qui utilisent votre produit de portail.
## Exemple de produit de portail d'adoption d'animaux de compagnie
Par exemple, vous pourriez avoir plusieurs REST APIs qui représentent un service d'adoption d'animaux de compagnie. Vous pouvez utiliser API Gateway pour créer un produit de `pet adoption` portail. Ce produit portail aiderait les clients à découvrir celui qu' APIsils devraient utiliser pour rencontrer et adopter des animaux de compagnie. Ce produit de portail utilise le REST APIs que vous avez déjà créé, mais il vous permet de les regrouper et de les organiser. Vous pouvez également fournir de la documentation sur les termes et conditions d'utilisation de votre produit de portail d'adoption pour animaux de compagnie et permettre aux clients d'essayer le vôtre APIs. Ces informations sont toutes stockées dans votre produit de portail.
Le tableau suivant en présente trois APIs qui représentent un produit de portail d'adoption pour animaux de compagnie, ainsi que les noms d'opérations de point de terminaison REST et les noms de section de page correspondants.
| IDENTIFIANT DE L'API REST | Chemin et méthode de l'API REST | Étape de l'API REST | Nom de l’opération | Section de page |
| --- | --- | --- | --- | --- |
| kf5387miad | GET /dogs | Prod | View dogs | AdoptAnimals |
| kf5387miad | GET /dogs/\$1dogId\$1 | Prod | View dog | AdoptAnimals |
| ra8obxcevg | GET /cats | Prod | View cats | AdoptAnimals |
| ra8obxcevg | GET /cats/\$1catId\$1 | Prod | View cat | AdoptAnimals |
| h0rpx9cm62 | ANY /user/\$1userId\$1/\$1petId\$1\$1 | Bêta | Request visit | AdoptProcess |
Dans cet exemple, deux REST `ra8obxcevg` et APIs`kf5387miad`, sont regroupés dans la `AdoptAnimals` section. Le résultat de cette navigation de commande ressemblerait à ce qui suit dans un portail :
![\[Portail d'adoption d'animaux\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/apigateway-portal.png)
Comme il s'agit d'une `ANY` méthode fourre-tout, le portail affiche toutes les méthodes HTTP prises en charge. Ce portail contient également de la documentation créée par le propriétaire du produit du portail.
## Étapes suivantes
Pour commencer à utiliser les produits du portail, vous pouvez effectuer les opérations suivantes :
+ Pour créer un produit de portail, voir[Création d'un produit de portail dans API Gateway](apigateway-portals-create-portal-product.md).
+ Pour en savoir plus sur la fonctionnalité d'essai, voir[Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail](apigateway-portals-try-it.md).
+ Pour en savoir plus sur les pages de produits, consultez[Création d'une page produit dans API Gateway](apigateway-portals-create-product-page.md).
+ Pour en savoir plus sur le partage de votre produit de portail, consultez[Partagez les produits du portail dans API Gateway](apigateway-portals-share-resources.md).
Après avoir créé un produit de portail, vous pouvez le publier sur un portail. Pour de plus amples informations, veuillez consulter [Création d'un portail dans API Gateway](apigateway-portals-create-portal.md).
# Création d'un produit de portail dans API Gateway
La procédure suivante indique comment créer un produit de portail. Un portail est un ensemble de *produits de portail*. Après avoir créé votre produit de portail, vous créez des points de terminaison REST et des pages de produits. Pour en savoir plus sur les produits du portail, consultez[Produits du portail dans API Gateway](apigateway-portals-portal-product.md).
## Considérations
Les considérations suivantes peuvent avoir une incidence sur la façon dont vous créez un produit de portail :
+ Votre produit de portail peut contenir des REST à la fois privés et publics APIs. Le APIs mode privé n'est pas pris en charge pour la fonctionnalité d'essai et, par conséquent, peut avoir une incidence visuelle sur votre portail. En tant que propriétaire du portail, vous devrez peut-être fournir une documentation expliquant cela.
+ Si vous créez votre produit de portail à l'aide du AWS CLI ou AWS SDKs, votre portail ne comportera aucun point de terminaison ni aucune page de produit. Vous devez ajouter ces ressources à l'aide de la console AWS CLI or. Pour savoir comment créer un point de terminaison REST pour un produit, consultez[Création d'un point de terminaison REST du produit dans API Gateway](apigateway-portals-create-product-rest-endpoint.md). Pour savoir comment créer une page produit, consultez[Création d'une page produit dans API Gateway](apigateway-portals-create-product-page.md).
## Création d'un produit de portail
La procédure suivante indique comment créer un produit de portail.
**Pour créer un produit de portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez **Créer un produit**.
1. Dans **Nom du produit**, entrez le nom du produit de votre portail.
1. Pour **Description du produit**, entrez une description.
1. Choisissez **Suivant**.
1. Pour sélectionner les points de terminaison REST de votre produit, sous **Points de terminaison d'API**, choisissez une API, puis choisissez une étape.
1. Pour ajouter un point de terminaison aux points de terminaison REST de votre produit, sélectionnez le point de terminaison de l'API, puis choisissez **Ajouter au produit**.
**Note**
Ne choisissez pas **Suivant** sans d'abord sélectionner **Ajouter au produit**.
![\[Produit Portal\]](http://docs.aws.amazon.com/fr_fr/apigateway/latest/developerguide/images/apigateway-portal-product.png)
Le point de terminaison de l'API apparaîtra dans la liste des **points de terminaison de l'API sélectionnés**.
1. Choisissez **Suivant**.
1. Passez en revue votre sélection et choisissez **Créer un produit**.
Une fois que vous avez créé votre produit de portail à l'aide de la console, toutes vos pages de produit et les pages de point de terminaison REST de vos produits sont des brouillons et n'apparaîtront pas dans un portail. Pour que vos pages de produits et les pages de point de terminaison REST de vos produits soient visibles par les consommateurs, vous devez ajouter votre brouillon à une section. Si vous créez votre produit de portail à l'aide du AWS CLI ou AWS SDKs, vous ajoutez le brouillon à la section de la AWS CLI commande. Quelle que soit la manière dont vous ajoutez votre brouillon à une section, vous devez publier le portail qui utilise les produits de votre portail pour qu'il soit visible par les consommateurs.
**Pour ajouter votre brouillon à une section de page**
1. Vos brouillons sont répertoriés dans l'onglet **Documentation**. Il existe des pages **de documentation de projet pour vos pages** de produit et des pages de **référence d'API de brouillon pour les pages** de point de terminaison REST de votre produit. Choisissez **Draft API reference pages**.
1. Choisissez un brouillon de page de référence d'API.
Si vous n'avez aucun point de terminaison REST de produit, vous n'aurez aucun brouillon de pages de référence d'API. Pour savoir comment créer un point de terminaison REST pour un produit, consultez[Création d'un point de terminaison REST du produit dans API Gateway](apigateway-portals-create-product-rest-endpoint.md).
1. Choisissez **Modifier la page**.
1. Sur cette page, vous pouvez remplacer toute partie de la documentation d'API existante ou utiliser la documentation d'API Gateway. Pour que le contenu de la page de point de terminaison REST de votre produit soit visible par les consommateurs, entrez un **nom sous Nom de section**. S'il s'agit du `/pets-GET` point de terminaison, le nom de la page pourrait être`Pets`.
1. Sélectionnez **Enregistrer les modifications**.
1. Le nouveau nom de page que vous avez créé apparaît dans la section des **pages de référence de l'API**.
Pour que la nouvelle page soit visible par les consommateurs, vous devez tout de même republier votre portail. Pour de plus amples informations, veuillez consulter [Publier un portail dans API Gateway](apigateway-portals-publish-portal.md).
# Création d'un point de terminaison REST du produit dans API Gateway
Un point de terminaison REST du produit est un point d'accès à votre produit de portail. Chaque point de terminaison comprend le chemin et la méthode d'une API REST et l'étape sur laquelle elle est déployée. Le point de terminaison inclut toute documentation que vous avez définie pour votre API REST, ou peut être mis à jour avec une documentation personnalisée. Lorsque vous créez le point de terminaison REST de votre produit, vous configurez les paramètres suivants :
+ Nom de l'opération du point de terminaison REST du produit. Si votre API REST possède le chemin et la méthode`GET /pets`, dans un portail, le nom est`/pets`. À l'aide du nom de l'opération, vous pouvez remplacer le nom du point de terminaison REST du produit par`Pet summaries`. Cela n'a aucun impact sur votre API existante.
+ La fonctionnalité d'essai pour le point de terminaison de votre produit. Cela permet aux utilisateurs d'API de tester votre APIs application sur votre portail. Si vous créez un point de terminaison de produit pour une API privée, la fonctionnalité d'essai est définie sur`UNAVAILABLE`. Pour de plus amples informations, veuillez consulter [Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail](apigateway-portals-try-it.md).
+ [Si des parties de documentation sont actuellement définies pour votre API REST, vous pouvez soit importer la documentation, soit remplacer votre documentation existante et créer une nouvelle documentation au niveau du produit à l'aide GitHub de Flavored Markdown.](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) Les modifications de documentation ne sont pas répercutées dans les parties de la documentation de votre API API Gateway. Si vous importez les parties de votre documentation actuelle, API Gateway synchronise les modifications apportées à votre API avec le point de terminaison REST de votre produit.
## Création d'un point de terminaison REST du produit
La procédure suivante montre comment ajouter un point de terminaison REST de produit à un produit de portail existant. Pour savoir comment créer ensemble un produit de portail et un point de terminaison REST de produit, voir[Création d'un produit de portail dans API Gateway](apigateway-portals-create-portal-product.md).
**Pour créer un point de terminaison REST de produit pour un portail de produit**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit de portail.
1. Choisissez l'onglet **Points de terminaison associés**, puis choisissez **Ajouter des points de terminaison**.
1. Pour sélectionner les points de terminaison REST de votre produit, sous **Points de terminaison d'API**, choisissez une API, puis choisissez une étape.
1. Pour ajouter un point de terminaison aux points de terminaison REST de votre produit, sélectionnez le point de terminaison de l'API, puis choisissez **Ajouter au produit**.
Le point de terminaison de l'API apparaîtra dans la liste des **points de terminaison de l'API sélectionnés**.
1. Sélectionnez **Envoyer**.
1. La page de point de terminaison REST de votre produit est désormais un brouillon. Choisissez **Draft API reference pages**, puis choisissez la page de point de terminaison REST de votre produit pour finaliser le contenu de la page.
1. Choisissez **Modifier la page**.
1. Pour remplacer la documentation existante d'API Gateway, dans le champ **Source de documentation**, activez l'option **Remplacer la documentation** et procédez comme suit :
1. Pour **Afficher le contenu**, choisissez **Create override**.
1. Dans **Nom de l'opération**, entrez un nouveau nom d'opération.
1. Pour **le corps de la page**, entrez votre documentation personnalisée.
1. (Facultatif) Pour **Endpoint**, entrez un point de terminaison personnalisé qui apparaît sur votre portail.
1. Pour permettre aux clients d'invoquer votre API sur votre portail, sélectionnez la **fonctionnalité Essayer**. Pour de plus amples informations, veuillez consulter [Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail](apigateway-portals-try-it.md).
1. **Dans Nom de section**, entrez un nom ou choisissez une section existante. Lorsque vous ajoutez le point de terminaison REST de votre produit à une section, les consommateurs peuvent consulter votre contenu sur un portail publié.
1. Sélectionnez **Enregistrer les modifications**.
Pour que la nouvelle page soit visible par les consommateurs, vous devez tout de même republier votre portail. Pour de plus amples informations, veuillez consulter [Publier un portail dans API Gateway](apigateway-portals-publish-portal.md).
# Création d'une page produit dans API Gateway
Une page produit aide les consommateurs à comprendre et à utiliser vos produits. La documentation se situe au niveau du produit, de sorte que tous les portails qui incluent votre produit disposent de cette documentation. API Gateway prend en charge deux types de pages de produits rédigées en [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) :
Page Présentation
Lorsque vous créez votre produit, API Gateway génère automatiquement une page de **présentation** de votre produit en fonction des informations que vous fournissez lors de la création de votre produit. Cette page comporte une mise en forme supplémentaire qui ne peut pas être modifiée. Vous pouvez modifier le texte ou supprimer la page du produit portail.
Pages personnalisées
Une page personnalisée est une page écrite en Markdown. Vous pouvez consulter cette section pour consulter les conditions générales ou suivre un didacticiel sur l'utilisation de votre produit. Vous pouvez transformer n'importe quelle page personnalisée en page d'aperçu. Lorsque vous transformez une page personnalisée en page d'aperçu, le contenu de la page est mis en forme pour correspondre à la page d'aperçu.
## Considérations
Les considérations suivantes peuvent avoir une incidence sur votre utilisation des pages de produits :
+ Cette documentation n'est pas au niveau de l'API et n'inclut aucune méthode, aucune ressource ou aucun paramètre de demande. Pour savoir comment modifier la documentation au niveau de l'API d'un produit, consultez. [Mettre à jour le point de terminaison REST d'un produit dans API Gateway](apigateway-portals-update-product-endpoint.md)
+ Vous ne pouvez pas charger directement un `.md` fichier sur votre produit.
+ Vous pouvez modifier l'ordre des pages de produits en modifiant la liste des pages dans l'ordre d'affichage de votre produit de portail. Pour de plus amples informations, veuillez consulter [Mettre à jour un produit de portail dans API Gateway](apigateway-portals-update-portal-product.md).
+ Vous devez republier tous les portails qui incluent votre produit pour que les modifications apportées à la documentation prennent effet.
+ Si plusieurs portails utilisent le même produit de portail, les pages de produits sont les mêmes sur tous les portails. Pour avoir les mêmes points de terminaison REST mais des pages de produit différentes, créez plusieurs produits.
## Création d'une page produit
La procédure suivante indique comment créer une page produit.
**Pour créer une page produit**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit.
1. Sous **Documentation**, choisissez **Créer une page personnalisée**.
1. Pour **Titre de page**, entrez le titre de la page.
1. Pour **Body**, entrez votre documentation supplémentaire à l'aide de GitHub Flavored Markdown.
La section **Aperçu** montre comment votre contenu apparaît sur un portail. Le style visuel final peut changer en fonction des paramètres de votre portail.
1. Choisissez **Créer une page de produit**.
1. Votre page produit est désormais un brouillon. Choisissez **Brouillon de pages de documentation**, puis choisissez votre page produit pour finaliser le contenu de la page.
1. Choisissez **Modifier la page**.
1. **Dans Nom de section**, entrez un nom ou choisissez une section existante. Lorsque vous ajoutez votre page produit à une section, les consommateurs peuvent consulter votre contenu sur un portail publié.
1. Sélectionnez **Enregistrer les modifications**.
Pour que la nouvelle page soit visible par les consommateurs, vous devez tout de même republier votre portail. Pour de plus amples informations, veuillez consulter [Publier un portail dans API Gateway](apigateway-portals-publish-portal.md).
# Mettre à jour un produit de portail dans API Gateway
Lorsque vous mettez à jour un produit de portail, vous pouvez modifier le nom, la description ou l'ordre d'affichage des points de terminaison REST et des pages de produits de votre produit. Pour modifier l'ordre d'affichage, vous devez modifier la liste des pages pour les pages de produits et le nom de section pour les points de terminaison des produits. Si vous le faites à l'aide du AWS CLI ou SDKs, vous spécifiez l'ARN de la page du produit ou l'ARN du point de terminaison REST du produit. Vous devez republier tous les portails qui utilisent vos produits pour les utilisateurs de vos API afin de voir les modifications reflétées dans un portail.
## Mettre à jour un produit de portail
La procédure suivante montre comment modifier la liste des sections pour réorganiser les points de terminaison REST du produit tels qu'ils apparaîtront sur un portail. Dans cette procédure, nous partons du principe que vous disposez d'au moins deux points de terminaison REST dans votre produit de portail.
**Pour mettre à jour un produit de portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit.
1. Dans l'onglet **Documentation**, pour les **pages de produits**, sélectionnez **Gérer**.
1. Faites glisser et déposez les points de terminaison REST du produit pour les réorganiser. Vous pouvez également déplacer les points de terminaison REST et les pages de produits vers la section des pages de brouillon. Les pages des brouillons ne seront pas visibles sur votre portail.
1. (Facultatif) Renommez les noms des points de terminaison REST du produit ou ajoutez une nouvelle section de référence d'API. Ces modifications n'auront aucun impact sur votre REST APIs.
1. Sélectionnez **Enregistrer les modifications**.
# Mettre à jour le point de terminaison REST d'un produit dans API Gateway
Lorsque vous mettez à jour un point de terminaison REST du produit, vous pouvez modifier tous les paramètres du point de terminaison du produit, à l'exception du chemin et de la méthode d'une API REST et de l'étape sur laquelle elle est déployée. Toutes les modifications apportées aux points de terminaison de vos produits sont mises à jour automatiquement, mais vous devez republier tous les portails qui utilisent vos produits pour que les modifications soient reflétées dans un portail.
## Mettre à jour un terminal REST du produit
La procédure suivante montre comment mettre à jour le point de terminaison REST d'un produit afin de remplacer la documentation d'API actuelle par une documentation de référence d'API personnalisée.
**Pour mettre à jour un point de terminaison REST du produit**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit.
1. 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**.
1. Pour **Aperçu**, choisissez **Modifier la page**.
1. Pour **Source de documentation**, activez **Remplacer la documentation**.
1. Pour **Afficher le contenu**, choisissez **Remplacer le contenu existant**.
Si vous choisissez **Supprimer tout le contenu**, celui-ci est supprimé de la page, mais vous pouvez choisir **Remplacer le contenu existant** pour accéder à nouveau à la documentation.
1. Dans le **corps de la page**, entrez une documentation de référence d'API personnalisée à l'aide de [GitHub Flavored Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).
Cette documentation ne sera pas repropagée vers API Gateway.
1. Sélectionnez **Enregistrer les modifications**.
1. Vous devez republier tous les portails qui utilisent ce produit de portail pour que les modifications prennent effet.
# Mettre à jour une page produit dans API Gateway
Lorsque vous mettez à jour une page produit, vous pouvez modifier tous les paramètres de la page produit. Toutes les modifications apportées à votre page produit sont mises à jour automatiquement, mais vous devez republier tous les portails qui utilisent vos produits pour que les modifications soient reflétées dans un portail.
# Partagez les produits du portail dans API Gateway
Vous pouvez partager un produit de portail à Comptes AWS l'aide de AWS RAM. Lorsque vous partagez un produit de portail, l'autre compte peut utiliser votre produit de portail sur son propre portail. Avec les produits de portail partagé, vous pouvez créer un catalogue unique des normes de gouvernance de votre organisation APIs et appliquer les normes de gouvernance dans l'ensemble de votre écosystème d'API. Dans le même temps, le partage de produits de portail offre aux fournisseurs d'API la flexibilité de développer, de tester et de gérer APIs dans leurs propres comptes.
## Considérations
Les considérations suivantes peuvent avoir une incidence sur la façon dont vous partagez les ressources du portail :
+ Lorsque vous partagez votre produit avec un autre compte, celui-ci ne peut modifier aucune des propriétés de votre API REST. Cela inclut les points de terminaison d'intégration, la stratégie d'autorisation ou la configuration des étapes.
+ Lorsque vous ajoutez le produit de portail d'un autre compte à votre portail, le propriétaire du produit du portail ne peut ni consulter ni contrôler les autres propriétés de votre portail. Le responsable du produit du portail sait uniquement que le produit est utilisé sur votre portail.
+ Les produits du portail API Gateway sont partagés au Région AWS niveau.
+ Vous pouvez utiliser un partage de ressources avec plusieurs principaux, et après avoir créé le partage de ressources, vous pouvez y ajouter d’autres principaux. Nous vous recommandons, dans la mesure du possible, de réutiliser votre partage de ressources.
+ Si les deux comptes appartiennent à la même organisation AWS Organizations, le partage des ressources est automatiquement accepté. Vous devez tout de même créer le partage de ressources à l’aide d’ AWS RAM.
+ Si les deux comptes appartiennent à la même organisation AWS Organizations et que le partage des ressources est activé au sein de votre organisation, tous les principaux de l'organisation avec lesquels vous partagez des ressources ont automatiquement accès aux partages de ressources. Aucune invitation n’est nécessaire et vous pouvez ignorer le partage des ressources.
+ Si le compte avec lequel vous avez partagé le produit n'accepte pas le partage de ressources dans les **12 heures**, vous devez partager à nouveau la ressource.
+ Après avoir créé le partage de ressources, AWS RAM met à jour la politique de partage de produits de votre produit afin d'empêcher l'accès aux principaux sans `allow` accès explicite. Pour plus d’informations, consultez [Determining whether a request is allowed or denied within an account](https://docs.aws.amazon.com//IAM/latest/UserGuide/reference_policies_evaluation-logic.html#policy-eval-denyallow) dans le Guide de l’utilisateur IAM.
La politique de ressources mise à jour ressemblera à ce qui suit :
```
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"apigateway:GetProduct",
"apigateway:ListEndpoints",
"apigateway:ListPages",
"apigateway:GetEndpoint",
"apigateway:GetPage"
],
"Resource": [
"arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id",
"arn:aws:apigateway:us-east-1:111122223333:/portalproducts/product-id/*"
]
}
]
}
```
AWS RAM a empêché les donneurs d'ordre sans autorisation explicite d'ajouter votre produit à leur portail, en ajoutant ce qui suit :
```
"StringNotEquals": { "aws:PrincipalAccount": "555555555555" }
```
Pour savoir comment partager un produit, consultez[Partagez votre produit de portail avec un propriétaire de portail dans API Gateway](apigateway-portals-share-products.md). Pour savoir comment ajouter un produit partagé avec vous sur votre portail, consultez[Ajoutez un produit de portail partagé à votre portail dans API Gateway](apigateway-portals-use-shared-products.md).
# Partagez votre produit de portail avec un propriétaire de portail dans API Gateway
En tant que propriétaire du produit, vous pouvez partager votre produit avec un propriétaire de portail dans le cadre d'une autre Compte AWS utilisation AWS RAM. Vous conservez le contrôle total de toutes les pages de produits et de toutes les pages de point de terminaison REST des produits.
## Considérations
Les considérations suivantes peuvent avoir une incidence sur la manière dont vous partagez les produits du portail :
+ Vous pouvez partager ou annuler le partage des produits de votre portail à tout moment. Si vous annulez le partage d'un produit de portail alors qu'il est utilisé dans un portail publié, le propriétaire du portail ne pourra pas voir le produit du portail, voir les mises à jour qui lui ont été apportées, ni republier ou prévisualiser le portail tant qu'il n'aura pas supprimé le produit de portail.
+ Vous pouvez consulter les produits du portail que vous avez partagés avec d'autres comptes.
+ Vous ne pouvez pas modifier les portails qui contiennent votre produit de portail, sauf si vous le créez vous-même.
## Partagez votre produit de portail
La procédure suivante indique comment créer un partage de ressources.
------
#### [ AWS Management Console ]
Pour l'utiliser AWS Management Console, reportez-vous à la section [Création d'un partage de ressources AWS RAM dans](https://docs.aws.amazon.com/ram/latest/userguide/working-with-sharing-create.html) le *guide de AWS RAM l'utilisateur*.
Pour **Sélectionner le type de ressource**, choisissez **API Gateway Product**.
------
#### [ AWS CLI ]
Ce qui suit [create-resource-share](https://docs.aws.amazon.com/cli/latest/reference/ram/create-resource-share.html)crée un partage de ressources pour votre nom de domaine personnalisé privé. L’association entre la ressource et le mandataire peut prendre quelques minutes. Pour les principaux, fournissez un ID de compte ou un ID d’organisation, comme `arn:aws:organizations::123456789012:organization/o-1234abcd`. Vous pouvez fournir plusieurs principaux pour votre partage de ressources.
```
aws ram create-resource-share \
--region us-west-2 \
--name portal-product-resource-share \
--permission-arns arn:aws:ram::aws:permission/AWSRAMDefaultPermissionAPIGatewayDeveloperPortalProduct \
--resource-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \
--principals 222222222222
```
------
Pour annuler le partage de votre produit de portail, utilisez cette option AWS RAM pour supprimer le partage de ressources.
À tout moment, vous pouvez modifier la politique de partage des produits afin de déterminer quels principaux peuvent utiliser les produits de votre portail sur leurs portails.
**Pour mettre à jour la politique de partage de produits**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit.
1. Dans l'onglet **Partage de produits**, pour **Politique de partage de produits**, choisissez **Gérer la politique de partage de produits**.
1. Si vous n'avez jamais partagé votre produit auparavant, votre politique de partage de produits refusera tout accès à d'autres comptes pour les produits de votre portail. Vous devez mettre à jour la politique pour autoriser l'accès à certains comptes à votre produit de portail.
1. Après avoir mis à jour votre politique de partage de produits, choisissez **Enregistrer les modifications**.
# Ajoutez un produit de portail partagé à votre portail dans API Gateway
En tant que propriétaire du portail, vous pouvez utiliser les produits du portail partagés avec vous par d'autres comptes sur votre portail. Vous gardez le contrôle total de votre portail.
## Considérations
Les considérations suivantes peuvent avoir une incidence sur la façon dont vous partagez les ressources du portail :
+ Vous devez accepter le partage des ressources du produit par le propriétaire du produit pour utiliser son produit sur votre portail. Si vous et le propriétaire du produit appartenez aux mêmes Organisations, vous AWS RAM pouvez effectuer certaines étapes de partage pour vous.
+ Si le propriétaire du produit annule le partage d'un produit alors qu'il se trouve sur votre portail publié, le produit sera toujours visible sur le portail, mais vous ne pourrez pas le publier à nouveau tant que vous n'aurez pas supprimé ce produit. En tant que propriétaire du portail, il est de votre responsabilité de supprimer le produit de votre portail, car le propriétaire du produit ne peut pas le faire à votre place.
+ Vous pouvez consulter les produits du portail, les pages de produits et les pages de point de terminaison REST du produit, mais vous ne pouvez modifier aucune de ces ressources.
+ Si un produit est partagé avec vous, vous ne pouvez pas le partager avec un autre compte.
## (Facultatif) Acceptez le partage de ressources
Une fois que le responsable du produit a créé un partage de ressources, vous avez **12 heures** pour l'accepter. Si vous travaillez dans la même organisation AWS Organizations que le propriétaire du produit, le partage est automatiquement accepté. Si vous faites partie d’une organisation qui a activé le partage automatique de ressources, celles-ci sont automatiquement partagées avec vous.
------
#### [ AWS Management Console ]
Pour l'utiliser AWS Management Console, voir [Accepter et rejeter des invitations à partager des ressources](https://docs.aws.amazon.com/ram/latest/userguide/working-with-shared-invitations.html) dans le *Guide de l'AWS RAM utilisateur*.
------
#### [ AWS CLI ]
Pour trouver toutes les ressources partagées avec vous, utilisez la [get-resource-share-invitations](https://docs.aws.amazon.com/cli/latest/reference/ram/get-resource-share-invitations.html)commande suivante :
```
aws ram get-resource-share-invitations \
--region us-west-2
```
Utilisez l’ARN de partage de ressources obtenu pour accepter l’invitation de partage de ressources. La [accept-resource-share-invitation](https://docs.aws.amazon.com/cli/latest/reference/ram/accept-resource-share-invitation.html)commande suivante accepte le partage de ressources.
```
aws ram accept-resource-share-invitation \
--resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/1e3477be-4a95-46b4-bbe0-c4001EXAMPLE \
--region us-west-2
```
------
## Ajouter un produit partagé à votre portail
Après avoir accepté le partage de ressources, vous ajoutez le produit à votre portail.
------
#### [ AWS Management Console ]
**Pour ajouter un produit partagé à votre portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Dans l'onglet **Produits**, pour les **produits du portail**, sélectionnez **Ajouter des produits**.
1. Ajoutez un produit à votre portail. Les produits partagés sont affichés comme `shared` dans la liste des produits.
1. Sélectionnez **Enregistrer les modifications**.
------
#### [ AWS CLI ]
Pour trouver tous les produits du portail partagés avec vous, utilisez la `get-portal-products` commande suivante :
```
aws apigatewayv2 get-portal-products \
--resource-owner OTHER_ACCOUNTS \
--region us-west-2
```
Pour ajouter un produit de portail partagé à votre portail, utilisez la `update-portal` commande suivante :
```
aws apigateway update-portal \
--included-portal-product-arns arn:aws:apigateway:us-west-2:111122223333:/portalproducts/p000000000 \
--region us-west-2
```
------
# 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, voir[Utiliser un portail API Gateway](apigateway-portals-use-portal.md).
**Activez Essayez-le pour un point de terminaison REST du produit**
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit.
1. 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**.
1. Choisissez **Modifier la page**.
1. Pour permettre aux clients d'invoquer votre API sur votre portail, sélectionnez la **fonctionnalité Essayer**.
1. Sélectionnez **Enregistrer les modifications**.
1. Vous devez republier tous les portails qui utilisent ce produit de portail pour que les modifications prennent effet.
# Supprimer un produit de portail dans API Gateway
Lorsque vous supprimez un produit du portail, il ne peut pas être récupéré.
## Supprimer un produit de portail
La procédure suivante indique comment supprimer un produit de portail.
**Pour supprimer un produit de portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez un produit de portail.
1. Sélectionnez **Delete (Supprimer)**.
1. Confirmez votre choix et choisissez **Supprimer**.
1. Vous devez republier tous les portails qui utilisent ce produit de portail pour que les modifications prennent effet.
# Création d'un portail dans API Gateway
Un portail est un ensemble de produits. Vous contrôlez l'autorisation, l'image de marque et la publication de votre portail. Lorsque vous créez un portail, son statut de publication est`Disabled`. Cela signifie que votre portail n'est pas détectable sur le Web. Pour permettre aux consommateurs d'accéder à votre portail, vous devez le publier. Avant de publier votre portail, vous pouvez également le prévisualiser.
API Gateway prend en charge les portails sur les navigateurs suivants :
+ Firefox
+ Google Chrome
+ Microsoft Edge
+ Safari
## Choisissez un nom de domaine
Par défaut, l'URL de votre portail est hébergée sur le nom de domaine Amazon suivant :
```
https://p-portalId.apigw-portal.us-east-1.on.aws
```
Pour personnaliser le nom de domaine, vous pouvez fournir un nom de domaine que vous possédez et un certificat SSL pour le domaine personnalisé. Le certificat doit être géré par [AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/)(ACM) dans l'est des États-Unis (Virginie du Nord) et être pris en charge par Amazon CloudFront. Pour plus d'informations, consultez la section [Exigences relatives à l'utilisation de SSL/TLS certificats avec CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-and-https-requirements.html).
Lorsque vous utilisez un nom de domaine personnalisé, API Gateway crée une CloudFront distribution, sécurisée en transit avec votre certificat ACM. API Gateway fournit ensuite un enregistrement d'alias, que vous ajoutez à votre configuration DNS. L'enregistrement d'alias est le nom de domaine appartenant à Amazon. Vous devez ajouter cet enregistrement d'alias pour diriger le trafic vers la CloudFront distribution de votre domaine personnalisé. Le nom de domaine que vous fournissez doit être unique et ne pas être déjà utilisé par la liste des alias d'une CloudFront distribution existante.
Si vous utilisez votre propre nom de domaine, API Gateway utilise la politique `TLS_1_2` de sécurité pour protéger votre portail. Pour plus d'informations, voir [Protocoles et chiffrements pris en charge entre les lecteurs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html). Vous ne pouvez pas modifier cette valeur.
## Création d'un portail
Vous utilisez la console API Gateway pour créer et configurer votre portail. Les procédures suivantes vous guident à travers toutes les étapes requises. Vous pouvez également choisir **Passer à la révision et créer** à la fin de la première procédure pour créer un portail vide.
La procédure suivante indique comment créer un portail. Vous devez d'abord définir les détails de votre portail.
**Pour définir les détails de votre portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez **Créer un portail**.
1. Dans Détails du portail, dans **Nom du portail**, entrez un nom.
1. Pour **Description du portail**, entrez une description.
1. Pour **l'autorisation du portail**, sélectionnez le mode d'autorisation de votre portail.
+ Si c'est la première fois que vous créez un portail, nous vous recommandons de choisir **Aucun**. Si vous prévoyez d'ajouter une production APIs à votre portail, utilisez **Exiger une autorisation**.
+ Pour obliger les utilisateurs du portail à s'authentifier pour utiliser votre portail, choisissez **Exiger une autorisation**, puis procédez comme suit :
1. Pour le groupe d'**utilisateurs Amazon Cognito,** sélectionnez votre groupe d'utilisateurs.
Le groupe d'utilisateurs doit se trouver dans la même région que votre portail.
1. Pour **ID client de l'application**, choisissez l'ID du client de l'application.
Dans le client de votre application, vous devez définir l'URL de rappel sur l'URL par défaut du portail.
1. Pour le **domaine du groupe d'utilisateurs**, entrez le domaine du groupe d'utilisateurs. Pour plus d'informations, consultez [la section Configuration d'un domaine de groupe d'utilisateurs](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-assign-domain.html).
1. Pour la **configuration du domaine**, sélectionnez le nom de domaine de votre portail.
+ Si c'est la première fois que vous créez un portail, nous vous recommandons de choisir le **domaine par défaut**. Une fois que vous aurez publié votre portail, il sera disponible à l'adresse`https://p-portalId.apigw-portal.us-east-1.on.aws`.
+ Pour fournir un nom de domaine personnalisé dont vous êtes le propriétaire, sélectionnez **Nom de domaine personnalisé** et procédez comme suit :
1. Pour **Nom de domaine**, entrez un nom de domaine complet.
1. Pour le **certificat ACM**, choisissez un certificat ACM qui couvre le nom de domaine.
Vous devez ajouter l'enregistrement d'alias fourni par API Gateway à votre enregistrement DNS afin de desservir le trafic provenant de votre portail.
1. Pour ajouter un moniteur d'application CloudWatch RUM à votre portail, pour le **moniteur d'application RUM**, choisissez un moniteur d'application. Pour plus d'informations, voir [CloudWatch RUM](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html).
1. Choisissez **Suivant**.
Après avoir défini les détails de votre portail, vous ajoutez des produits de portail. Vous pouvez modifier les produits du portail à tout moment, mais vous devez republier votre portail pour que les modifications prennent effet.
**Pour sélectionner les produits de votre portail**
1. Dans la liste des ressources, sélectionnez les produits à ajouter à votre portail.
1. Choisissez **Suivant**.
Après avoir sélectionné vos produits, vous personnalisez le design du portail. Pour télécharger un logo de portail, vous devez charger une image sur Amazon S3. Vous pouvez modifier ces valeurs à tout moment, mais vous devez republier votre portail pour que les modifications prennent effet.
**(Facultatif) Pour personnaliser votre portail**
1. Pour **le logo du portail**, indiquez l'URI S3 de votre fichier.
Seulement `.svg``.png`, ou `.jpg` sont pris en charge.
1. Pour personnaliser le design de votre portail, deux options s'offrent à vous :
1. Vous pouvez choisir le **thème du portail** pour appliquer un thème de couleur prédéfini sur votre portail.
1. Vous pouvez utiliser les sélecteurs de couleur pour sélectionner toutes les options de conception de votre portail.
1. Choisissez **Suivant**.
Après avoir sélectionné le design du portail, passez en revue les informations relatives au portail.
**Pour consulter votre portail**
+ Vérifiez vos paramètres sur la page de révision et de création. Lorsque vous êtes satisfait de vos paramètres, choisissez **Create (Créer)**.
Si vous utilisez un groupe d'utilisateurs Amazon Cognito pour contrôler l'accès à votre portail, vous devez définir l'URL de rappel sur l'URL par défaut du portail dans l'application cliente. Pour plus d'informations, consultez la section [Paramètres spécifiques à l'application avec les clients d'applications](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-client-apps.html).
Votre portail ne sera plus accessible aux consommateurs une fois que vous l'aurez créé. Vous devez publier votre portail pour qu'il soit accessible sur Internet. Pour de plus amples informations, veuillez consulter [Publier un portail dans API Gateway](apigateway-portals-publish-portal.md).
# Mettre à jour un portail dans API Gateway
Vous pouvez mettre à jour le thème, le logo ou les produits du portail dans votre portail. Lorsque vous mettez à jour votre portail, les modifications ne prennent effet que lorsque vous le republiez.
## Mettre à jour un portail
La procédure suivante indique comment mettre à jour la conception d'un portail.
**Pour mettre à jour la conception d'un portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Dans l'onglet **Conception du portail**, choisissez **Modifier**.
1. Pour mettre à jour le logo du portail, choisissez **Mettre à jour le logo du portail**. Vous pouvez soit supprimer le logo existant, soit utiliser un nouveau logo.
1. Apportez n'importe quelle mise à jour du thème ou de l'arrière-plan à la conception de votre portail.
1. Sélectionnez **Enregistrer les modifications**.
1. (Facultatif) Choisissez **Générer un aperçu du portail pour afficher** vos modifications.
Après avoir confirmé vos modifications, publiez votre portail.
1. Choisissez **Publier le portail**.
1. Entrez une description pour la mise à jour de votre portail et choisissez **Publier**.
# Aperçu d'un portail dans API Gateway
Vous pouvez prévisualiser votre portail avant de le publier. API Gateway crée une URL éphémère que vous pouvez utiliser pour prévisualiser la version de votre portail que les clients verront une fois votre portail publié.
## Considérations
Les considérations suivantes peuvent avoir une incidence sur la façon dont vous prévisualisez un portail :
+ Essayez, il n'est pas activé pour votre portail de prévisualisation. Pour de plus amples informations, veuillez consulter [Activez, essayez-le pour le point de terminaison REST d'un produit API Gateway sur votre portail](apigateway-portals-try-it.md).
## Afficher un aperçu d'un portail
La procédure suivante indique comment prévisualiser un portail.
**Pour prévisualiser un portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Choisissez **Générer un aperçu du portail**.
N'actualisez pas votre page.
1. Une fois qu'API Gateway a généré votre aperçu, choisissez **Open portal preview**.
L'aperçu de votre portail s'ouvrira dans un nouvel onglet.
# Publier un portail dans API Gateway
Pour que les utilisateurs d'API puissent accéder à votre portail, vous devez le publier. L'URL d'un portail peut être découverte par n'importe qui sur Internet. Nous vous recommandons de prévisualiser et de sécuriser votre portail avant de le publier.
## Considérations
API Gateway peut prendre quelques minutes pour publier votre portail. Vous pouvez surveiller l'**état de publication** dans la console.
## Publier un portail
La procédure suivante indique comment publier un portail.
**Pour publier un portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Choisissez **Publier le portail**.
1. (Facultatif) **Dans Description des modifications**, entrez une description de votre modification.
Lorsque vous publiez un portail, nous vous recommandons de toujours fournir une brève description de vos modifications.
1. Choisissez **Publish**.
API Gateway met quelques minutes à terminer la publication de votre portail. API Gateway fournit un lien vers votre portail lorsqu'il est disponible.
Pour supprimer votre portail, vous devez d'abord le désactiver. Pour de plus amples informations, veuillez consulter [Désactiver un portail dans API Gateway](apigateway-portals-disable-portal.md).
# 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**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Copiez le **nom de domaine par défaut du portail** ou le **nom de domaine** et saisissez-le dans un navigateur.
1. 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.
1. Choisissez un produit de portail.
1. Choisissez un point de terminaison REST du produit.
1. Dans la fenêtre **Try it**, entrez les paramètres pour essayer d'appeler votre API.
1. 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**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portal products**.
1. Choisissez votre produit de portail.
1. 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**.
# Désactiver un portail dans API Gateway
Lorsque vous désactivez un portail, celui-ci n'est plus disponible sur le Web. Après avoir désactivé un portail, vous pouvez soit le supprimer, soit le republier si nécessaire.
## Désactiver un portail
La procédure suivante indique comment désactiver un portail.
**Pour désactiver un portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Choisissez **Actions**, puis sélectionnez **Désactiver le portail**.
1. Confirmez votre choix et choisissez **Désactiver le portail**.
Le **statut de publication** deviendra **Désactivé**.
Pour supprimer le statut de désactivation du portail, publiez-le à nouveau.
# Supprimer un portail dans API Gateway
Lorsque vous supprimez un portail, il ne peut pas être récupéré et vous devez d'abord le désactiver. Si vous souhaitez supprimer votre portail du Web, vous pouvez le désactiver. Cela vous permet de modifier votre portail et de le republier ultérieurement.
## Supprimer un portail
La procédure suivante indique comment supprimer un portail.
**Pour supprimer un portail**
1. Connectez-vous à la console API Gateway à l'adresse [https://console.aws.amazon.com/apigateway.](https://console.aws.amazon.com/apigateway)
1. Dans le volet de navigation principal, sélectionnez **Portals**.
1. Choisissez un portail.
1. Si votre portail n'est pas désactivé, désactivez-le en choisissant **Actions**, **Désactiver le portail**.
La désactivation de votre portail prend quelques minutes. Vous pouvez surveiller l'**état de publication** pour voir si le statut de publication de votre portail est désactivé.
1. Après avoir dépublié votre portail, vous pouvez le supprimer. Pour supprimer votre portail, choisissez **Actions**, **Supprimer le portail**. Confirmez votre choix et choisissez **Supprimer**.