Inizia a utilizzare l'hub API

Stai visualizzando la documentazione di Apigee X.
Visualizza la documentazione di Apigee Edge.

Prerequisiti

Devi soddisfare i seguenti prerequisiti:

Completato? Prerequisito Descrizione
Account di fatturazione Google Cloud

Devi avere un account Google Cloud con fatturazione attiva.

Per maggiori informazioni, consulta la pagina Creare un nuovo account di fatturazione.

Progetto Google Cloud

Crea un nuovo progetto Google Cloud.

I nomi dei progetti devono rispettare le seguenti linee guida:

  • Inizia con una lettera minuscola. Ad esempio, my-org va bene, ma _my-org non lo è.
  • Includi solo lettere minuscole, numeri o trattini (-).

Per ulteriori informazioni, consulta Creazione di un progetto.

Software

Installa il seguente software sulla tua macchina amministrativa:

  • Google Cloud SDK (obbligatorio per la riga di comando; consigliato per le installazioni basate su UI)
  • curl (facoltativo, ma fortemente consigliato)
Autorizzazioni

Per chiamare una delle API di provisioning, devi avere il ruolo Apigee Registry Admin.

Per la configurazione di P4SA e CMEK, devi avere il ruolo Proprietario (roles/owner) o Amministratore di Cloud KMS (roles/cloudkms.admin). Per saperne di più, consulta la sezione Prima di iniziare.

Per informazioni sulla concessione dei ruoli, vedi Gestisci l'accesso ai progetti, alle cartelle e alle organizzazioni.

Chiave di crittografia

Devi avere una chiave di crittografia gestita dal cliente (CMEK).

Se non ne hai già uno, puoi crearne uno come parte del processo di provisioning come descritto nella sezione Creare P4SA e CMEK.

Configura gcloud

Configura l'interfaccia a riga di comando di Google Cloud (gcloud):

  1. Soddisfa i requisiti di configurazione elencati nella sezione Prerequisiti.
  2. Inizializza Cloud SDK, come descritto in Inizializzazione di Cloud SDK, oppure assicurati che il progetto Google Cloud che hai creato in Prerequisiti sia il progetto predefinito per gcloud.
  3. Imposta la proprietà project:
    gcloud config set project PROJECT_ID
    

    Dove PROJECT_ID è l'ID progetto cloud che hai creato come parte dei prerequisiti.

  4. Installa i componenti gcloud beta:
    gcloud components install beta
    

Abilita API

Per utilizzare l'hub API, devi abilitare le seguenti API per il progetto in Google Cloud Console:

  • API Apigee Registry
  • API Cloud Key Management Service (KMS): consente ai clienti di gestire le chiavi di crittografia ed eseguire operazioni crittografiche con tali chiavi.
  • API Service Usage:abilita i servizi che i consumer di servizi vogliono utilizzare su Google Cloud Platform, elenca i servizi disponibili o abilitati o disabilita i servizi che i consumatori di servizi non utilizzano più.

Puoi utilizzare l'interfaccia a riga di comando o la UI di Google Cloud Console per abilitare le API.

console

Per abilitare le API utilizzando l'interfaccia utente, procedi come descritto di seguito:

  1. In Cloud Console, vai ad API e servizi per il tuo progetto.

    Vai ad API e servizi

  2. Fai clic su Abilita API e servizi.
  3. Abilita l'API Apigee Registry:
    1. Nella visualizzazione Libreria API, digita
      apigee registry api
      nella casella di ricerca e premi Invio.
    2. Individua l'API Apigee Registry e fai clic.

    3. Fai clic su Abilita.

      Google Cloud abilita l'API per il tuo progetto Google Cloud

  4. Attiva l'API Cloud Key Management Service (KMS):
    1. Nella visualizzazione Libreria API, digita
      cloud key management service (kms) api
      nella casella di ricerca e premi Invio.
    2. Fai clic sull'API Cloud Key Management Service (KMS).

    3. Fai clic su Abilita.

      Google Cloud abilita l'API per il tuo progetto Google Cloud

  5. Attiva l'API Service Usage:
    1. Nella visualizzazione Libreria API, digita
      service usage api
      nella casella di ricerca e premi Invio.
    2. Fai clic sull'API Service Usage.

    3. Fai clic su Abilita.
  6. Per confermare di aver attivato le API, seleziona API e servizi > API abilitate e servizi.

    Le API appena aggiunte vengono visualizzate nell'elenco delle API abilitate:

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

gcloud

  1. Esegui questo comando:

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

    Dove PROJECT_ID è il nome del tuo progetto Cloud Console.

  2. (Facoltativo) Per controllare il tuo lavoro, usa il comando services list per mostrare tutte le API abilitate:

    gcloud services list
    

    La risposta mostra tutti i servizi abilitati, comprese le API che hai appena abilitato.

Ruoli

I seguenti ruoli utente forniscono le autorizzazioni che controllano l'accesso alle funzioni dell'hub API:

  • Amministratore: accesso completo a tutte le risorse nel Registro di sistema e funzionalità pianificate per il provisioning automatico e la gestione delle istanze
  • Editor: accesso in modifica alle risorse dell'hub API e del Registro di sistema.
  • Visualizzatore: accesso in sola lettura alle risorse del Registro di sistema e dell'hub delle API.
  • Worker: ruolo predefinito per i worker dell'applicazione Apigee Registry in grado di leggere e aggiornare le risorse Apigee Registry.

I pulsanti di azione sono disattivati se non disponi delle autorizzazioni appropriate per eseguire l'azione.

Configurazione delle autorizzazioni IAM

Per informazioni dettagliate sulle autorizzazioni, consulta i ruoli IAM.

Per aggiungere utenti e ruoli:

  1. In Cloud Console, vai a IAM e amministrazione per il progetto.

    Vai alla pagina IAM/Iam

  2. Per aggiungere un nuovo utente:
    1. Fai clic su Aggiungi.
    2. Digita un nuovo nome Entità.
    3. Fai clic sul menu Seleziona un ruolo, quindi su Apigee Registry e quindi su una delle seguenti opzioni:
      • Amministratore Cloud Apigee Registry
      • Editor Cloud Apigee Registry
      • Visualizzatore Cloud Apigee Registry
      • Worker Cloud Apigee Registry
    4. Fai clic su Salva.
  3. Per modificare un utente esistente:
    1. Fai clic su Modifica.
    2. Per modificare un ruolo esistente, fai clic sul menu Ruolo e selezionane uno diverso.
    3. Per aggiungere un altro ruolo, fai clic su Aggiungi un altro ruolo.
    4. Fai clic sul menu Seleziona un ruolo, quindi su Apigee Registry e quindi su una delle seguenti opzioni:
      • Amministratore Cloud Apigee Registry
      • Editor Cloud Apigee Registry
      • Visualizzatore Cloud Apigee Registry
      • Worker Cloud Apigee Registry
    5. Fai clic su Salva.

Esegui il provisioning di API Hub

Segui le istruzioni riportate in Eseguire il provisioning dell'hub API.

Accesso all'hub API

Per accedere all'hub API:

In Cloud Console, vai alla pagina Hub API Apigee.

Vai all'API Hub

L'hub API mostra un riquadro di navigazione e un riquadro come mostrato di seguito. La pagina API viene visualizzata per impostazione predefinita:

Scheda Cronologia

Importa dati esistenti

Consulta la pagina Apigee/registry/demo per alcune dimostrazioni sull'importazione collettiva tramite lo strumento del Registro di sistema.

Passaggi successivi