Introduzione all'API Apigee

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

L'API Apigee può essere utilizzata per sviluppare e gestire le API a livello di programmazione con un set di operazioni RESTful.

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

Per ulteriori informazioni, consulta la pagina relativa all'API Apigee.

Abilitazione dell'API Apigee

Assicurati di aver abilitato l'API Apigee. Il modo più semplice per abilitare un'API per il tuo progetto consiste nell'utilizzare la console Google Cloud. Per i dettagli completi, vedi Passaggio 3: abilita le API.

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 il tuo account Google Cloud le credenziali per un token di accesso che potrai utilizzare per effettuare chiamate sicure all'API Apigee. Una volta quando si ottiene un token, non è necessario scambiare nuovamente le credenziali fino alla scadenza del token.

Ottenere un token utilizzando le credenziali Google Cloud

Per ricevere un token utilizzando le tue credenziali Google Cloud:

  1. Autorizza gcloud ad accedere a piattaforma Cloud con le tue credenziali utente Google: 
    gcloud auth login
  2. Richiedi 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 Autorizzazione. Ad esempio: 
    curl "https://apigee.googleapis.com/v1/organizations" -H "Authorization: Bearer $TOKEN"

Ricevere 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 usando la console di Google Cloud. come descritto in Creazione e gestione delle chiavi degli account di servizio.

    Sul computer viene scaricato un file JSON contenente le credenziali dell'account di servizio.

  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 Intestazione di autorizzazione. 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ù variabili di ambiente definite nella tabella seguente.

Impostando 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 dimostrare come sviluppare applicazioni. utilizzando l'API Apigee. curl è uno strumento open source a riga di comando per il trasferimento dei dati con la sintassi degli URL, supportando protocolli comuni come HTTP e HTTPS.

La seguente tabella 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 sul modulo che puoi trasmettere specificando un nome file.
-H
--header		 Definisce un'intestazione della richiesta.

Devi passare le seguenti informazioni nell'intestazione della richiesta:

  • Intestazione Authorization: Token OAuth 2.0 per l'autenticazione degli utenti, come descritto consulta la sezione Ottenere un token di accesso OAuth 2.0.
  • Intestazione Content-Type: tipo di contenuto del corpo della richiesta inviato quando la creazione o l'aggiornamento di una risorsa (POST, PATCH, PUT) mediante 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 tuo token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0.