Provare l'API

API Open | gRPC

Il 21 marzo 2022 è stato ritirato il portale Cloud Endpoints. Il portale Cloud Endpoints non sarà più disponibile dopo il 21 marzo 2023. Il traffico API gestito da Cloud Endpoints non è interessato da questa modifica. Per maggiori informazioni, consulta la pagina Ritiro delle funzionalità.

Oltre a visualizzare la documentazione di riferimento dell'API SmartDocs, gli sviluppatori possono utilizzare il riquadro Prova questa API per interagire con l'API senza uscire dalla documentazione. Gli sviluppatori possono inviare richieste alla tua API nel tuo portale e vedere le risposte. Provare l'API nel portale aiuta gli utenti a comprendere cosa devono fare per far funzionare il loro codice con l'API.

Se l'API richiede una chiave API o l'autenticazione, devi configurare il portale in modo che gli utenti possano interagire con l'API. In questa pagina vengono descritti i requisiti e la configurazione da seguire per permettere agli sviluppatori di utilizzare Prova questa API. 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:

• Informazioni sui ruoli
• Concessione, modifica e revoca dell'accesso alle risorse
• Creazione e gestione dei ruoli personalizzati

Prerequisiti

• Devi aver eseguito il deployment del backend dell'API.
• Se l'API richiede una chiave API, il file di configurazione del servizio deve essere configurato come descritto in Limitazione dell'accesso API con chiavi API.
• Se l'API richiede l'autenticazione, il file di configurazione del servizio deve essere configurato come descritto in Autenticazione degli utenti.
• L'API deve essere raggiungibile tramite DNS. Se l'API non è configurata per utilizzare un nome di dominio personalizzato (ad esempio, example-api.example.com), devi configurarla in modo che utilizzi il dominio cloud.goog.
• Poiché Prova questa API supporta solo REST, devi configurare la transcodifica HTTP/JSON per il tuo servizio gRPC.

Configurazione delle impostazioni di Explorer API

Se l'API richiede una chiave API e/o l'autenticazione Firebase o Auth0, devi configurare queste impostazioni prima che gli utenti possano provare l'API. Questa sezione descrive come configurare una chiave API e le impostazioni di autenticazione.

Autorizzazioni richieste per questa attività

Per eseguire questa attività, devi avere il ruolo di Editor di progetto nel progetto.

Configurazione di una chiave API

Per configurare una chiave API nel portale:

1. In Google Cloud Console, vai alla sezione API e servizi e credenziali.

   Vai alla pagina Credenziali

2. Nell'elenco a discesa Progetto nella finestra superiore di Google Cloud Console, seleziona il progetto Google Cloud in cui hai creato l'API.

   • Se hai una chiave API esistente che vuoi utilizzare:

     1. Fai clic su Modifica chiave API accanto alla chiave API che vuoi utilizzare.
     2. A destra della chiave API, fai clic su Copia per copiare la chiave API negli appunti.
     3. Fai clic su Annulla.

   • Se devi creare una chiave API:

     1. Fai clic su Crea credenziali, quindi seleziona Chiave API.
     2. Copia la chiave negli appunti.
     3. Fai clic su Chiudi.

3. Torna al portale.

4. Fai clic su Impostazioni .

5. Fai clic sulla scheda API e seleziona l'API dall'elenco a discesa.

6. Nella sezione Impostazioni Explorer API, incolla la chiave API nel campo Chiave API di Google.

7. Fai clic su Salva.

Configurazione di Firebase

Per configurare Firebase:

1. Apri la Console Firebase.

   • Se non disponi di un progetto Firebase esistente:

     1. Fai clic su Aggiungi progetto e seleziona il nome del progetto Google Cloud che contiene l'API.
     2. Nella scheda Autenticazione, fai clic su Inizia.
     3. Fai clic sulla scheda Metodo di accesso.
     4. Nella sezione Fornitori di accesso, attiva i fornitori che vuoi utilizzare.
     5. Nella sezione Domini autorizzati, fai clic su Aggiungi dominio e aggiungi il nome di dominio del tuo portale (ad esempio, endpointsportal.example-api.example.com).
     6. Fai clic su Web Configuration (Configurazione web). Viene visualizzato lo snippet di codice personalizzato. Lascia aperta la Console Firebase perché hai bisogno delle informazioni dello snippet di codice nei passaggi seguenti.

   • Se hai già un progetto Firebase:

     1. Vai a Develop (Sviluppo) > Authentication (Autenticazione).
     2. Fai clic sulla scheda Metodo di accesso.
     3. Nella sezione Domini autorizzati, fai clic su Aggiungi dominio e aggiungi il nome di dominio del tuo portale (ad esempio, endpointsportal.example-api.example.com).
     4. Fai clic su Web Configuration (Configurazione web). Viene visualizzato lo snippet di codice personalizzato. Lascia aperta la Console Firebase perché hai bisogno delle informazioni dello snippet di codice nei passaggi seguenti.

2. Apri un'altra scheda del browser e vai al portale.

3. Fai clic su Impostazioni .

4. Nella pagina Impostazioni, fai clic sulla scheda API e seleziona l'API dall'elenco a discesa.

5. Nella sezione Impostazioni Explorer API:

   1. Copia il valore del campo apiKey dallo snippet di codice Firebase e incollalo nel campo Chiave API di Google.
   2. Copia il valore del campo authDomain dallo snippet di codice Firebase e incollalo nel campo Dominio di autenticazione Firebase.

6. Fai clic su Salva.

Per ulteriori informazioni, consulta la documentazione di Firebase.

Configurazione di Auth0

Utilizza il seguente elenco di attività di alto livello per configurare Auth0 e il tuo portale:

Attività 1. Assicurati che sia presente un'API Auth0 per il servizio Cloud Endpoints.

Attività 2. Configura le impostazioni dell'applicazione Auth0.

Attività 3. Configura le impostazioni Auth0 nel portale.

Attività 1: assicurati che sia presente un'API Auth0 per il servizio Endpoints

1. Accedi alla dashboard di Auth0.

2. Nella barra di navigazione a sinistra, fai clic su API. Se è presente un Pubblico API nel formato https://SERVICE_NAME, dove SERVICE_NAME è il nome del tuo servizio endpoint, significa che hai già creato un'API. Continua con l'attività successiva per configurare le impostazioni dell'applicazione Auth0.

   In caso contrario, crea un'API:

   1. Fai clic su + Crea API.
   2. Inserisci un nome.

   3. Nel campo Identificatore, inserisci un URL nel formato: https://SERVICE_NAME

      Sostituisci SERVICE_NAME con il nome del tuo servizio endpoint. Se hai dubbi sul nome del servizio, vedi Ricevere il nome del servizio e l'ID configurazione per informazioni su come trovare il nome del servizio endpoint.

   4. Fai clic su Crea.

Attività 2: configura le impostazioni dell'applicazione Auth0

1. Nella Dashboard Auth0, fai clic su Applicazioni nella barra di navigazione a sinistra.
2. Seleziona l'applicazione Auth0 o fai clic su + Crea applicazione per crearne una nuova.

3. Nella scheda Impostazioni della tua applicazione, scorri verso il basso e aggiungi l'URL di reindirizzamento OAuth del portale al campo URL di callback consentiti. L'URL di reindirizzamento OAuth del portale è più URL di /oauth/redirect (ad esempio, https://endpointsportal.example-api.example.com/oauth/redirect).

   Il campo URL di callback consentiti accetta più URL separati da una virgola. Assicurati che l'URL inserito non includa un carattere / finale.

4. Fai clic su Salva modifiche.

   Lascia aperta la scheda del browser in Impostazioni Auth0 perché per eseguire questa operazione sono necessari i passaggi riportati di seguito.

Attività 3: configura le impostazioni di Auth0 nel portale

1. Apri un'altra scheda del browser e vai al portale.
2. Fai clic su Impostazioni .
3. Nella pagina Impostazioni, fai clic sulla scheda API e seleziona l'API dall'elenco a discesa.

4. Nella sezione Impostazioni Explorer API:

   1. Copia il valore del campo Client ID (ID client) nella dashboard di Auth0 e incollalo nel campo Auth0 client ID (ID client Auth0).
   2. Copia il valore del campo Domain nella dashboard Auth0 e incollalo nel campo Auth0 domain (Dominio Auth0).

5. Fai clic su Salva.

Per ulteriori informazioni sulla configurazione di Auth0, consulta la panoramica della dashboard di Auth0 nella documentazione di Auth0.