Premiers pas avec API Hub

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

Preview — Apigee API hub

Cette fonctionnalité est soumise aux "Conditions des offres de pré-DG" dans la section "Conditions d'utilisation générales" des Conditions spécifiques au service. Les fonctionnalités pré-DG sont disponibles "en l'état" et peuvent avoir une assistance limitée. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Remarque: Un script qui effectue ces étapes de provisionnement est disponible à l'adresse apigee/registry-experimental.

Prérequis

Vous devez remplir les prérequis suivants :

C'est fait ?	Prérequis	Description
	Compte de facturation Google Cloud	Vous devez disposer d'un compte Google Cloud pour lequel la facturation est active. Pour plus d'informations, consultez la section Créer un compte de facturation.
	Projet Google Cloud	Créez un projet Google Cloud. Les noms de projet doivent respecter les consignes suivantes : Commencer par une lettre minuscule. Par exemple, my-org est accepté, mais _my-org ne l'est pas. N'incluez que des lettres minuscules, des chiffres ou des traits d'union (-). Pour en savoir plus, consultez la page Créer un cluster.
	Logiciels	Installez les logiciels suivants sur votre ordinateur administratif : SDK Google Cloud (obligatoire pour la ligne de commande ; recommandé pour les installations basées sur l'interface utilisateur) curl (facultatif, mais fortement suggéré)
	Autorisations	Pour appeler l'une des API de gestion des comptes, vous devez disposer du rôle Apigee Registry Admin. Pour la configuration de P4SA et de CMEK, vous devez disposer du rôle Propriétaire (roles/owner) ou Administrateur Cloud KMS (roles/cloudkms.admin). Pour en savoir plus, consultez la section Avant de commencer. Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.
	Encryption key (Clé de chiffrement)	Vous devez disposer d'une clé de chiffrement gérée par le client (CMEK). Si vous n'en possédez pas déjà une, vous pouvez en créer une dans le cadre du processus de provisionnement, comme décrit dans la section Créer un P4SA et un CMEK.

Configurer gcloud

Configurez Google Cloud CLI (gcloud) :

1. Remplissez les prérequis de configuration répertoriées dans Prérequis.
2. Initialisez le SDK Cloud comme décrit sur la page Initialiser le SDK Cloud ou vérifiez que le projet Google Cloud que vous avez créé dans la section Prérequis est le projet par défaut pour gcloud.
3. Définissez la propriété project :

   gcloud config set project PROJECT_ID
   

   PROJECT_ID est l'ID du projet Cloud que vous avez créé dans la section Prérequis.

4. Installez les composants gcloud beta :

   gcloud components install beta
   

Activer les API

Pour utiliser le hub d'API, vous devez activer les API suivantes pour le projet dans Google Cloud Console :

• API Apigee Registry
• API Cloud Key Management Service (KMS): permet aux clients de gérer les clés de chiffrement et d'effectuer des opérations de chiffrement avec celles-ci.
• API Service Usage: ctive les services que les clients de service souhaitent utiliser sur Google Cloud Platform, répertorie les services disponibles ou activés, ou désactive les services que les clients de service n'utilisent plus.

Vous pouvez utiliser la CLI ou l'interface utilisateur de Google Cloud Console pour activer les API.

Console

Pour activer les API à l'aide de l'interface utilisateur, procédez comme suit:

1. Dans Cloud Console, accédez à la page API et services de votre projet.

   Accéder aux API et services

2. Cliquez sur Activer les API et les services.
3. Activez l'API Apigee Registry :
1. Dans la vue Bibliothèque d'API, saisissez

   apigee registry api

   dans le champ de recherche, puis appuyez sur Entrée.

2. Localisez l'API Apigee Registry et cliquez dessus.

   

3. Cliquez sur Activer.

   Google Cloud active l'API Apigee pour votre projet Google Cloud.

4. Activez l'API Cloud Key Management Service (KMS) :
1. Dans la vue Bibliothèque d'API, saisissez

   cloud key management service (kms) api

   dans le champ de recherche, puis appuyez sur Entrée.

2. Cliquez sur API Cloud Key Management Service (KMS).

   

3. Cliquez sur Activer.

   Google Cloud active l'API Apigee pour votre projet Google Cloud.

5. Activer l'API Service Usage :
1. Dans la vue Bibliothèque d'API, saisissez

   service usage api

   dans le champ de recherche, puis appuyez sur Entrée.

2. Cliquez sur API Service Usage.

   
3. Cliquez sur Activer.

6. Pour confirmer que vous avez activé les API, sélectionnez API et services > API et services activés.

   Les API que vous venez d'ajouter sont affichées dans la liste des API activées :

   • API Apigee Registry
   • API Cloud Key Management Service (KMS)
   • API Service Usage

gcloud

1. Exécutez la commande suivante :

   gcloud services enable \
       apigeeregistry.googleapis.com \
       cloudkms.googleapis.com \
       serviceusage.googleapis.com --project=PROJECT_ID
   

   Où PROJECT_ID est le nom de votre projet Cloud Console.

2. (Facultatif) Pour vérifier votre travail, utilisez la commande services list pour afficher toutes les API activées :

   gcloud services list
   

   La réponse affiche tous les services activés, y compris les API que vous venez d'activer.

Rôles

Les rôles utilisateur suivants fournissent des autorisations qui contrôlent l'accès aux fonctions du hub d'API :

Remarque : La version bêta ne fournit qu'un contrôle d'accès à faible précision et quatre rôles de base. Un contrôle des accès plus précis et des intégrations avec d'autres parties d'Apigee sont prévus pour la version en disponibilité générale.

• Administrateur : accès complet à toutes les ressources du registre, ainsi que des fonctionnalités planifiées pour le provisionnement automatisé et la gestion des instances.
• Éditeur : accès en modification au hub d'API et aux ressources de registre.
• Lecteur : accès en lecture seule au hub d'API et aux ressources de registre.
• Nœud de calcul : rôle prédéfini permettant aux nœuds de calcul d'application Apigee Registry de lire et de mettre à jour des ressources Apigee Registry.

Les boutons d'action sont désactivés si vous ne disposez pas des autorisations nécessaires pour effectuer l'action.

Configurer les autorisations IAM

Pour obtenir des informations détaillées sur les autorisations, consultez la page Rôles IAM.

Pour ajouter des utilisateurs et des rôles :

1. Dans Cloud Console, accédez à IAM et administration pour votre projet.

   Accéder à la page IAM/Iam

2. Pour ajouter un utilisateur :
   1. Cliquez sur Ajouter.
   2. Saisissez un nouveau nom pour le Compte principal.
   3. Cliquez sur le menu Sélectionner un rôle, cliquez sur Apigee Registry, puis sur l'une des options suivantes :
      • Administrateur Cloud Apigee Registry
      • Éditeur Cloud Apigee Registry
      • Lecteur Cloud Apigee Registry
      • Nœud de calcul Cloud Apigee Registry
   4. Cliquez sur Enregistrer.
3. Pour modifier les informations associées à un utilisateur existant :
   1. Cliquez sur Modifier.
   2. Pour modifier un rôle existant, cliquez sur le menu Rôle, puis sélectionnez un autre rôle.
   3. Pour ajouter un autre rôle, cliquez sur Ajouter un autre rôle.
   4. Cliquez sur le menu Sélectionner un rôle, cliquez sur Apigee Registry, puis sur l'une des options suivantes :
      • Administrateur Cloud Apigee Registry
      • Éditeur Cloud Apigee Registry
      • Lecteur Cloud Apigee Registry
      • Nœud de calcul Cloud Apigee Registry
   5. Cliquez sur Enregistrer.

Provisionner le hub d'API

Suivez les instructions de la section Hub des API de gestion des comptes.

Accéder au hub d'API

Pour accéder au hub d'API :

Dans Cloud Console, accédez à la page du hub d'API Apigee.

Accéder au hub d'API

Le hub d'API affiche un volet de navigation et un volet de contenu, comme illustré ci-dessous. La page de la liste des API s'affiche par défaut :

Importer des données

Consultez la page apigee/registry/demos pour obtenir des démonstrations d'importation groupée avec l'outil de registre.

Étape suivante

• Vous êtes un consommateur et vous recherchez des API à utiliser ?
  Voir :
  • Découvrir les API à l'aide de la liste des API
• Vous êtes un producteur et vous voulez ajouter des API au hub d'API ?
  Voir :
  • Présentation des API
  • Enregistrer des API
• Vous êtes un administrateur et vous définissez les règles et les normes ?
  Voir :
  • Présentation des API
  • Enregistrer des API
  • Gestion des versions
  • Gérer les déploiements
  • Gérer les révisions
  • Gérer les catégories
  • Gérer les étapes du cycle de vie
  • Déclarer des dépendances
  • Personnaliser l'affichage de l'API Hub