Iniziare a utilizzare l'API Apigee

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza Apigee Edge documentazione.

L'API Apigee può essere utilizzata per sviluppare e gestire le API in modo programmatico con un insieme di operazioni RESTful.

Puoi utilizzare l'API Apigee per integrare la gestione dei proxy API nel ciclo di vita dello sviluppo del software (SDLC) della tua organizzazione. Un utilizzo comune dell'API Apigee è la scrittura di script o codice che eseguono il deployment dei proxy API o che migrano i proxy API da un ambiente a un altro, nell'ambito di un processo automatizzato più ampio che esegue anche il deployment o la migrazione di altre applicazioni.

Per saperne di più, consulta API Apigee.

Nota importante sull'utilizzo per la residenza dei dati: per supportare la residenza dei dati, quando esegui il provisioning o utilizzi Apigee devi utilizzare un endpoint regionale. Per saperne di più, consulta Utilizzare gli endpoint regionali per la residenza dei dati.

Abilitare l'API Apigee

Assicurati di aver abilitato l'API Apigee. Il modo più semplice per abilitare un'API per il tuo progetto è utilizzare l'interfaccia utente di Apigee. Per informazioni complete, consulta Passaggio 1: abilita le API richieste.

Ottenere un token di accesso OAuth 2.0

L'API Apigee supporta OAuth 2.0 per l'autenticazione degli utenti. Con OAuth 2.0, scambi le tue credenziali Google Cloud con un token di accesso che puoi utilizzare per effettuare chiamate sicure all'API Apigee. Una volta ottenuto un token, non devi scambiare di nuovo le credenziali finché il token non scade.

Nota: le credenziali dell'account di servizio di breve durata sono utili per gli scenari in cui devi concedere l'accesso limitato alle risorse per gli account di servizio attendibili e riducono il rischio rispetto all'utilizzo di credenziali di lunga durata come le chiavi dell'account di servizio. Per saperne di più, consulta Generare un token di accesso OAuth 2.0.

Ottenere un token utilizzando le credenziali Google Cloud

Per ottenere un token utilizzando le credenziali Google Cloud:

1. Autorizza gcloud ad accedere a piattaforma Cloud con le credenziali utente Google:

   gcloud auth login

2. Ottieni un token per l'account attualmente attivo:

   export TOKEN=$(gcloud auth print-access-token)

3. Quando chiami un'API Apigee, passa il token di accesso nell'intestazione Authorization. Ad esempio:

   curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

Ottenere un token utilizzando una chiave dell'account di servizio Google Cloud

Per ottenere un token utilizzando una chiave dell'account di servizio per l'autorizzazione:

1. Genera una chiave per il tuo account di servizio utilizzando la Google Cloud console, come descritto in Creare e gestire le account di servizio account.

   Un file JSON contenente le credenziali del tuo account di servizio viene scaricato sul computer.

2. Imposta la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS sul percorso in cui si trova la chiave dell'account di servizio:

   export GOOGLE_APPLICATION_CREDENTIALS=your_sa_credentials_file.json

3. Quando chiami un'API Apigee, utilizza Google Cloud CLI per aggiungere un token di accesso all' intestazione Authorization. Ad esempio:

   curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)"

Impostare le variabili di ambiente per le richieste API Apigee

Gli esempi di API Apigee e gcloud CLI forniti nella documentazione utilizzano una o più delle variabili di ambiente definite nella tabella seguente.

Se imposti in anticipo le variabili di ambiente su valori significativi nel tuo ambiente, puoi copiare e incollare le richieste di esempio per eseguirle nel tuo ambiente con modifiche minime o nulle.

Variabile di ambiente	Descrizione
$API	Nome del proxy API.
$APIPRODUCT	Nome del prodotto API.
$APP	ID di un'app.
$DEVELOPER_EMAIL	Indirizzo email dello sviluppatore.
$ENV	Nome dell'ambiente, ad esempio test o prod.
$ID	ID risorsa.
$KEY	Chiave utente.
$NAME	Nome della risorsa.
$ORG	La tua organizzazione Apigee.
$REV	Numero di revisione del proxy API.
$SHAREDFLOW	Nome del flusso condiviso.
$TYPE	Tipo di risorsa.

Utilizzo di curl

Gli esempi in questa sezione utilizzano curl per mostrare come sviluppare applicazioni utilizzando l'API Apigee. curl è uno strumento open source a riga di comando per il trasferimento di dati con sintassi URL, che supporta protocolli comuni come HTTP e HTTPS.

La tabella seguente riassume le opzioni della riga di comando curl utilizzate negli esempi.

Opzione	Descrizione
-d '{}' --data @filename --data-binary @filename	Definisce il corpo della richiesta, che puoi passare direttamente o specificando un nome file.
-F file=@filename --form file=@filename	Definisce i dati basati su moduli che puoi passare specificando un nome file.
-H --header	Definisce un'intestazione della richiesta. Nell'intestazione della richiesta devi passare le seguenti informazioni: Authorization header: token OAuth 2.0 per l'autenticazione degli utenti, come descritto in Ottenere un token di accesso OAuth 2.0. Content-Type header: tipo di contenuto del corpo della richiesta inviato durante la creazione o l'aggiornamento di una risorsa (POST, PATCH, PUT) utilizzando l'API.
-X	Specifica il tipo di richiesta (GET, POST e così via).

Ad esempio:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis" \
   -X GET \
   -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0.