Introduzione all'uso del portale Cloud Endpoints

In questa pagina viene descritto come creare un portale per il tuo servizio Cloud Endpoints e viene introdotta l'interfaccia utente del portale. Per ogni attività viene fornito il ruolo o i ruoli minimi richiesti per completare l'attività. Per ulteriori informazioni sulle autorizzazioni IAM, consulta quanto segue:

Prerequisiti

Questa pagina presuppone che tu abbia già:

Crea un portale

Per creare un portale:

  1. Nella console Google Cloud, vai alla pagina Endpoint e portale sviluppatore.

    Vai al portale Cloud Endpoints

  2. Seleziona il progetto Cloud in cui si trova l'API.
  3. Fai clic su Crea portale. La generazione del portale richiede in genere tra 5 e 10 minuti. Quando il portale è pronto, viene visualizzato un URL.

La creazione di un portale ha i seguenti effetti:

  • Durante la creazione del portale, viene creato un account di servizio denominato service-YOUR_PROJECT_NUMBER@endpoints-portal.iam.gserviceaccount.com con il ruolo Agente di servizio Portale endpoint. YOUR_PROJECT_NUMBER è il numero del tuo progetto Cloud. Puoi visualizzare questo account di servizio nella console di Google Cloud nella pagina IAM e amministrazione > IAM per il tuo progetto Cloud.

  • Quando viene creato, il portale utilizza il nome di dominio endpointsportal.YOUR_PROJECT_ID.cloud.goog. YOUR_PROJECT_ID è il tuo ID progetto Cloud. A supporto di ciò, un certificato SSL/TLS e un record DNS pubblico contenente il tuo ID progetto vengono creati e sono disponibili per la ricerca nei log di Certificate Transparency pubblici, anche se il tuo portale non è pubblicamente accessibile.

Visualizzare il portale di un'API

Per visualizzare il portale di un'API:

  1. Nella pagina Endpoint e > Portale sviluppatori, fai clic sull'URL nella sezione URL portale.

  2. Segui le istruzioni di accesso per continuare sul tuo portale. Se disponi di più account, assicurati di scegliere quello che fa parte del progetto Cloud in cui si trova l'API.

    Viene visualizzata la home page del tuo portale. Per praticità, ti consigliamo di aggiungere questo URL ai preferiti. La home page del portale visualizza un elenco con i link a tutte le API nel progetto Cloud.

  3. Fai clic sull'API che vuoi esplorare. Viene visualizzata la home page dell'API.

Introduzione all'interfaccia utente del portale

Nella parte inferiore della home page dell'API, le seguenti icone forniscono link utili per gli utenti dell'API.

  • Riferimento API mostra la prima pagina della documentazione di riferimento dell'API SmartDocs generata dal portale endpoint da il file openapi.json creato dagli endpoints Frameworks. Puoi utilizzare la barra di navigazione a sinistra per visualizzare la documentazione di SmartDocs per ogni metodo e risorsa.

  • Nella sezione Per iniziare vengono visualizzati contenuti di esempio nella Guida introduttiva. Prima di inviare l'URL del portale agli utenti della tua API, personalizza questa documentazione in modo che fornisca le informazioni di cui gli utenti dell'API hanno bisogno per iniziare a utilizzare l'API nel loro codice. Consulta la sezione Aggiunta di documentazione personalizzata per informazioni su come modificare i contenuti nella guida Per iniziare.

  • Ottieni una chiave mostra la pagina API e servizi; libreria API in modo che gli utenti possano abilitare la tua API nei propri progetti Google Cloud.

    Se l'API richiede una chiave API, dopo aver attivato l'API, gli utenti possono accedere alla pagina API e servizi e credenziali per ottenere una chiave API che possono utilizzare nel codice. Prima di inviare l'URL del portale agli utenti della tua API, devi concedere loro l'accesso per utilizzare la tua API. Per ulteriori informazioni, consulta la pagina Controllare chi può abilitare l'API.

Personalizzare l'aspetto del portale

Ti consigliamo di modificare gli schemi di colori e le icone visualizzati sul portale in modo che corrispondano al sito web della tua azienda. Modificando l'aspetto e configurando un dominio personalizzato per il portale, puoi creare un'esperienza brandizzata per gli utenti.

Per personalizzare l'aspetto del portale:

  1. Fai clic su Impostazioni nell'angolo in alto a destra della pagina.

  2. Fai clic sulla scheda A livello di sito. Puoi modificare l'aspetto dei seguenti elementi:

    • Logo
    • Colore principale, utilizzato come colore di sfondo della home page e della barra del titolo.
    • Colore secondario, utilizzato come colore delle icone e dei link.
    • Titolo della home page.
    • Descrizione della home page.

  3. Fai clic su Salva.

Eliminazione di un portale

Per eliminare un portale:

  1. Nella console Google Cloud, vai alla pagina Endpoint e portale sviluppatore.

    Vai al portale Cloud Endpoints

  2. Seleziona il progetto Cloud in cui si trova l'API.
  3. Fai clic su Elimina .
  4. Nella finestra di dialogo di conferma, fai clic su Elimina.

Passaggi successivi

Scopri di più su: