Création d'un portail dans API Gateway - Amazon API Gateway
Choisissez un nom de domaineCréation d'un portail

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.

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 estDisabled. 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(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.

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. 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.

  2. Dans le volet de navigation principal, sélectionnez Portals.

  3. Choisissez Créer un portail.

  4. Dans Détails du portail, dans Nom du portail, entrez un nom.

  5. Pour Description du portail, entrez une description.

  6. 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.

      2. 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.

      3. 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.

  7. 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'adressehttps://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.

      2. 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.

  8. 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.

  9. 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.

  2. 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.

  2. 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.

    2. Vous pouvez utiliser les sélecteurs de couleur pour sélectionner toutes les options de conception de votre portail.

  3. 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.

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.