Premiers pas avec le portail Cloud Endpoints

OpenAPI | gRPC

Le portail Cloud Endpoints est obsolète depuis le 21 mars 2022. Le portail Cloud Endpoints ne sera plus disponible après le 21 mars 2023. Le trafic des API géré par Cloud Endpoints n'est pas affecté par cette modification. Pour en savoir plus, consultez la page Abandons de fonctionnalités.

Cette page explique comment créer un portail pour votre service Cloud Endpoints et présente l'interface utilisateur du portail. Pour chaque tâche, le ou les rôles Identity and Access Management minimaux requis pour l'exécution sont fournis. Pour en savoir plus sur les autorisations IAM, consultez les pages suivantes :

• Comprendre les rôles
• Accorder, modifier et révoquer les accès à des ressources
• Créer et gérer les rôles personnalisés

Prerequisites

Cette page suppose que vous avez déjà :

• créé un projet Google Cloud ;
• créé un document OpenAPI pour votre API, comme décrit dans Configurer Endpoints ;
• déployé votre document OpenAPI comme décrit dans Déployer la configuration Endpoints.

Créer un portail

Autorisations requises pour cette tâche

Pour effectuer cette tâche, vous devez disposer de l'autorisation serviceusage.services.enable sur le projet. Le rôle d'Éditeur de projet sur le projet dispose de cette autorisation.

Pour créer un portail :

1. Dans Google Cloud Console, accédez à la page Endpoints > Portail des développeurs.

   Accéder au portail Cloud Endpoints

2. Sélectionnez le projet Cloud dans lequel se trouve l'API.
3. Cliquez sur Créer un portail. Cinq à dix minutes sont généralement nécessaires pour générer le portail. Lorsque le portail est prêt, son URL est affichée.

La création d'un portail a les effets suivants :

• Lors de la création du portail, un compte de service portant le nom [e-mail] est créé avec le rôle Agent de service du portail Endpoints. (YOUR_PROJECT_NUMBER est le numéro de votre projet Google Cloud). Ce compte de service est disponible dans Google Cloud Console sur la page IAM et administration > IAM de votre projet Cloud.

  Important : Ne supprimez pas le compte de service du portail Cloud Endpoints, et ne modifiez pas ses autorisations. Cela rendrait le portail inutilisable. En outre, n'attribuez pas le rôle Agent de service du portail Endpoints à d'autres comptes principaux.

• Une fois le portail créé, il utilise le nom de domaine endpointsportal.YOUR_PROJECT_ID.cloud.goog. (YOUR_PROJECT_ID est votre ID de projet cloud.) Pour ce faire, un certificat SSL/TLS et un enregistrement DNS public contenant votre ID de projet sont créés et peuvent faire l'objet d'une recherche dans les journaux de transparence des certificats publics, même si votre portail n'est pas accessible au public.

Afficher le portail pour une API

Autorisations requises pour cette tâche

Pour effectuer cette tâche, vous devez disposer des autorisations suivantes :

• Utilisateurs de l'API : servicemanagement.services.bind sur le service Endpoints. Le rôle Client du service contient cette autorisation. Pour en savoir plus, consultez la page Contrôler qui peut activer votre API.
• Comptes principaux ayant accès au projet parent pour le service Endpoints : servicemanagement.services.get sur le projet. Le rôle Lecteur contient cette autorisation. Pour en savoir plus, consultez la page Accorder, modifier et révoquer les accès à des ressources.

Pour afficher le portail pour une API :

1. Sur la page Endpoints > Portail des développeurs, dans la section URL du portail, cliquez sur l'URL.

2. Suivez les invites de connexion pour accéder à votre portail. Si vous avez plusieurs comptes, veillez à choisir celui du projet Cloud dans lequel se trouve l'API.

   La page d'accueil du portail s'affiche. Par souci de simplicité, nous vous conseillons d'ajouter cette URL à vos favoris. La page d'accueil du portail affiche une liste de liens vers l'ensemble des API du projet Cloud.

3. Cliquez sur l'API à explorer. La page d'accueil de l'API est affichée.

Présentation de l'interface utilisateur du portail

Les icônes ci-après, situées en bas de la page d'accueil de votre API, fournissent des liens utiles aux utilisateurs de votre API.

• L'icône référence sur l'API affiche la première page de la documentation de référence Smartdocs sur l'API, générée par le portail Cloud Endpoints à partir de votre document OpenAPI. Vous pouvez utiliser la barre de navigation à gauche pour afficher la documentation SmartDocs pour chaque méthode et chaque ressource.

• L'icône Premiers pas  affiche un exemple de contenu dans le guide de démarrage. Avant d'envoyer l'URL du portail aux utilisateurs de votre API, personnalisez cette documentation afin de fournir aux utilisateurs les informations dont ils ont besoin pour commencer à utiliser l'API dans leur code. Consultez la page Ajouter de la documentation personnalisée pour découvrir comment modifier le contenu du guide de démarrage.

• L'icône Obtenir une clé  affiche la page API et services > Bibliothèque d'API afin que les utilisateurs puissent activer votre API dans leurs propres projets Google Cloud.

  Si votre API nécessite une clé API, les utilisateurs peuvent accéder à la page API et services > Identifiants pour obtenir une clé API intégrable dans leur code, après avoir activé votre API. Avant d'envoyer l'URL du portail aux utilisateurs de votre API, vous devez leur accorder l'accès à l'API. Pour en savoir plus, consultez la page Contrôler qui peut activer votre API.

Personnaliser l'apparence de votre portail

Si vous le souhaitez, vous pouvez modifier certains aspects tels que les jeux de couleurs et les icônes affichées sur votre portail, afin de les adapter au site Web de votre entreprise. En modifiant l'apparence et en configurant un domaine personnalisé pour votre portail, vous pouvez créer une expérience à l'image de votre marque pour les utilisateurs.

Autorisations requises pour cette tâche

Pour effectuer cette tâche, vous devez disposer de l'autorisation endpoints.portals.update sur le projet. Les rôles Administrateur du portail Endpoints et Éditeur de projet sur le projet disposent de cette autorisation.

Pour personnaliser l'apparence de votre portail :

1. Dans l'angle supérieur droit de la page, cliquez sur Paramètres .

2. Cliquez sur l'onglet Sur l'ensemble du site. Vous pouvez modifier l'apparence des éléments suivants :

   • Logo
   • Couleur principale, utilisée comme couleur d'arrière-plan de la page d'accueil et de la barre de titre
   • Couleur secondaire, utilisée comme couleur pour les icônes et les liens
   • Titre de la page d'accueil
   • Description de la page d'accueil

3. Cliquez sur Enregistrer.

Supprimer un portail

Autorisations requises pour cette tâche

Pour effectuer cette tâche, vous devez disposer de l'autorisation serviceusage.services.disable sur le projet. Le rôle d'Éditeur de projet sur le projet dispose de cette autorisation.

Pour supprimer un portail :

1. Dans Google Cloud Console, accédez à la page Endpoints > Portail des développeurs.

   Accéder au portail Cloud Endpoints

2. Sélectionnez le projet Cloud dans lequel se trouve l'API.
3. Cliquez sur Supprimer ().
4. Dans la boîte de dialogue de confirmation, cliquez sur Supprimer.

Étapes suivantes

Découvrez les points suivants :

• Les champs utilisés par le portail Endpoints dans votre configuration Endpoints pour générer la documentation de référence SmartDocs et comment regénérer SmartDocs.
• Les autorisations du rôle Administrateur du portail Endpoints.
• Comment ajouter une documentation personnalisée à votre portail.