Guida operativa

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Come ottenere una chiave API

L'esempio seguente spiega come ottenere una chiave API che puoi utilizzare per convalidare le chiamate API a un servizio di destinazione trasferite al proxy tramite Apigee Adapter for Envoy.

1. Accedi ad Apigee

  1. Apri l'interfaccia utente di Apigee in un browser.
  2. Una volta nell'interfaccia utente, seleziona la stessa organizzazione che hai utilizzato per configurare Apigee Adapter for Envoy.

2. Creazione di uno sviluppatore

Puoi utilizzare uno sviluppatore esistente per i test oppure crearne uno nuovo nel seguente modo:

  1. Seleziona Pubblica > Sviluppatori nel menu di navigazione laterale.
  2. Fai clic su + Sviluppatore.
  3. Compila la finestra di dialogo per creare un nuovo sviluppatore. Puoi utilizzare qualsiasi nome/indirizzo email sviluppatore che preferisci.

3. Creazione di un prodotto API

Segui l'esempio di creazione dei prodotti fornito di seguito. Vedi anche Informazioni sulla configurazione del prodotto API.

  1. Seleziona Pubblica > Prodotti API nel menu di navigazione laterale.
  2. Fai clic su + Prodotto API.
  3. Compila la pagina Dettagli prodotto come segue. Non fare clic su Salva finché non ti viene chiesto di farlo.
    4. Campo Valore
    Nome httpbin-product
    Display Name httpbin product
    Ambiente your_environment

    Impostalo sull'ambiente utilizzato quando hai eseguito il provisioning di Apigee Adapter per Envoy con apigee-remote-service-cli.

    Accesso Private
    Quota 5 richieste ogni minuto

    Vedi anche Informazioni sulle quote.

  4. Nella sezione Target di servizio remoto Apigee, fai clic su Aggiungi target di servizio remoto Apigee.
  5. Nella finestra di dialogo della destinazione del servizio remoto Apigee, aggiungi i seguenti valori:
    Attributo Valore Descrizione
    Nome destinazione Inserisci il nome del servizio di destinazione. Ad esempio: httpbin.org L'endpoint di destinazione indirizzato al proxy Envoy.
    proxy API remote-service Il proxy remote-service di cui è stato eseguito il provisioning su Apigee durante l'installazione di Envoy Adapter.
    Percorso Inserisci un valore /resource_path da associare a un percorso specifico. Ad esempio: /httpbin. Il percorso di richiesta per la corrispondenza nell'endpoint di destinazione. Le chiamate proxy API a questo percorso corrisponderanno a questo prodotto API.

    Cloud pubblico o privato perimetrale: lo screenshot seguente mostra le impostazioni della finestra di dialogo configurate correttamente per la destinazione httpbin.org, una configurazione adeguata per il cloud pubblico o privato Apigee Edge.

  6. Fai clic su Salva.

4. Creazione di un'app sviluppatore

  1. Seleziona Pubblica > App nel menu di navigazione laterale.
  2. Fai clic su + App.
  3. Compila la pagina App sviluppatore come segue. Non salvare fino a quando ti viene chiesto di farlo.
    4. Nome httpbin-app
    Display Name httpbin app
    Developer Seleziona lo sviluppatore che hai creato in precedenza o scegli quello che preferisci dall'elenco.
  4. Poi, aggiungi due prodotti all'app:
    1. Innanzitutto, nella sezione Credenziali, fai clic su + Aggiungi prodotto e seleziona il prodotto appena configurato: httpbin-product.
    2. Quindi, aggiungi il prodotto remote-service. Questo prodotto è stato creato automaticamente quando hai eseguito il provisioning di Apigee.
  5. Fai clic su Crea.
  6. In Credenziali, fai clic su Mostra accanto a Chiave.
  7. Copia il valore della chiave utente. Questo valore è la chiave API che utilizzerai per effettuare chiamate API al servizio httpbin.

Informazioni sui prodotti basati su API

I prodotti API sono il punto di controllo principale per Apigee Remote Service. Quando crei un prodotto API e lo associ a un servizio di destinazione, crei un criterio che verrà applicato a tutte le richieste che configuri il tuo Apigee Adapter for Envoy per gestire.

Definizione del prodotto API

Quando definisci un prodotto API in Apigee, puoi impostare un numero di parametri che verranno utilizzati per valutare le richieste:

  • Target
  • Percorso richiesta
  • Quota
  • Ambiti OAuth

Destinazioni dei servizi remoti

La definizione del prodotto API verrà applicata a una richiesta se quest'ultima corrisponde sia all'associazione di destinazione (ad esempio httpbin.org) sia al percorso di richiesta (ad esempio /httpbin). Un elenco di potenziali target viene archiviato come attributo nel prodotto API.

Per impostazione predefinita, il servizio remoto Apigee controlla l'intestazione :authority (host) speciale di Envoy rispetto al suo elenco di destinazioni. Tuttavia, può essere configurato per l'utilizzo di altre intestazioni.

Percorso risorsa API

Il percorso inserito corrisponde alle seguenti regole:

  • Una singola barra (/) corrisponde a qualsiasi percorso.
  • * è valido ovunque e corrisponde all'interno di un segmento (tra barre).
  • ** è valido alla fine e corrisponde a qualsiasi cosa alla fine della riga.

Quota

Una quota specifica il numero di messaggi di richiesta che un'app può inviare a un'API nel corso di un'ora, un giorno, una settimana o un mese. Quando un'app raggiunge il limite di quota, le successive chiamate API vengono rifiutate.

Casi d'uso delle quote

Le quote consentono di applicare il numero di richieste che un client può effettuare a un servizio in un determinato periodo di tempo. Le quote vengono spesso utilizzate per applicare contratti aziendali o SLA (accordi sul livello del servizio) con sviluppatori e partner, anziché per la gestione del traffico operativo. Ad esempio, potrebbe essere utilizzata una quota per limitare il traffico di un servizio senza costi, consentendo al contempo l'accesso completo ai clienti paganti.

La quota viene definita in un prodotto API

I parametri delle quote sono configurati nei prodotti API. Ad esempio, quando crei un prodotto API, puoi facoltativamente impostare il limite di quota consentito, l'unità di tempo e l'intervallo.

Poiché le chiavi API vengono rimappate ai prodotti API, ogni volta che una chiave API viene verificata, il contatore di quota appropriato può essere ridotto (se nel prodotto associato è stata definita una quota).

A differenza del runtime Apigee, le quote inserite nella definizione del prodotto vengono applicate automaticamente dal servizio remoto Apigee. Se la richiesta viene autorizzata, viene conteggiata nella quota consentita.

Dove vengono mantenute le quote

Le quote vengono mantenute e controllate localmente dal processo del servizio remoto e mantenute in modo asincrono con Apigee Runtime. Ciò significa che le quote non sono precise e potrebbero subire un superamento se hai più di un servizio remoto che mantiene la quota. Se la connessione al runtime Apigee viene interrotta, la quota locale continuerà come quota autonoma fino al momento in cui potrà riconnettersi al runtime Apigee.

Ambiti OAuth

Se utilizzi token JWT, puoi limitare i token a sottoinsiemi degli ambiti OAuth consentiti. Gli ambiti assegnati al token JWT emesso verranno verificati in base agli ambiti del prodotto API.

Informazioni sulle app per sviluppatori

Una volta configurati i Prodotti API, dovrai creare un'App associata a uno Sviluppatore. L'app consente a un client l'accesso ai prodotti API associati con una chiave API o un token JWT.

Utilizzo dell'autenticazione basata su JWT

Puoi utilizzare un token JWT per effettuare chiamate proxy API autenticate anziché utilizzare una chiave API. Questa sezione spiega come utilizzare il comando apigee-remote-service-cli token per creare, ispezionare e ruotare i token JWT.

Panoramica

La verifica e l'autenticazione JWT vengono gestite da Envoy utilizzando il suo filtro di autenticazione JWT.

Una volta autenticato, il filtro ext-authz di Envoy invia le intestazioni delle richieste e il JWT a apigee-remote-service-envoy. Corrisponde alle rivendicazioni api_product_list e scope del JWT nei confronti dei Prodotti API Apigee per autorizzarlo a fronte del target della richiesta.

Creazione di token JWT Apigee

I token JWT Apigee possono essere creati utilizzando l'interfaccia a riga di comando:

apigee-remote-service-cli token create -c config.yaml --id $KEY --secret $SECRET

In alternativa, puoi utilizzare l'endpoint del token OAuth standard. Esempio di ricciolo:

curl https://org-env.apigee.net/remote-service/token -d '{"client_id":"myclientid","client_secret":"myclientsecret","grant_type":"client_credentials"}' -H "Content-type: application/json"

Utilizzo del token JWT

Una volta ottenuto il token, devi semplicemente passarlo a Envoy nell'intestazione Autorizzazione. Esempio:

curl localhost:8080/httpbin/headers -i -H "Authorization:Bearer $TOKEN"

Errore del token JWT

Rifiuto di Envoy

Se Envoy rifiuta il token, è possibile che venga visualizzato un messaggio come:

Jwks remote fetch is failed

In questo caso, assicurati che la configurazione Envoy contenga un URI valido nella sezione remote_jwks, che sia raggiungibile da Envoy e di aver impostato correttamente i certificati quando hai installato il proxy Apigee. Dovresti essere in grado di chiamare l'URI direttamente con una chiamata GET e ricevere una risposta JSON valida.

Esempio:

curl https://myorg-eval-test.apigee.net/remote-service/certs

Altri messaggi di Envoy potrebbero avere il seguente aspetto:

  • "I segmenti di pubblico in Jwt non sono consentiti"
  • "L'emittente Jwt non è configurato"

Questi derivano dai requisiti della tua configurazione Envoy che potresti dover modificare.

Ispeziona un token

Puoi utilizzare l'interfaccia a riga di comando per esaminare il token. Esempio

apigee-remote-service-cli -c config.yaml token inspect -f path/to/file

o 

apigee-remote-service-cli -c config.yaml token inspect <<< $TOKEN

Debug

Vedi Errori relativi a una chiave API valida.

Logging

Puoi regolare il livello di logging sul servizio $REMOTE_SERVICE_HOME/apigee-remote-service-envoy. Tutto il logging viene inviato a stderr.

Elemento Obbligatorie Descrizione
-l, --log-level Livelli validi: debug, informazioni, avviso, errore. Regola il livello di logging. Predefinito: info
-j, --json-log Emette l'output di log come record JSON.

Envoy fornisce il logging. Per ulteriori informazioni, consulta i seguenti link alla documentazione Envoy:

Utilizzo di un proxy di rete

Un proxy HTTP può essere inserito utilizzando le variabili di ambiente HTTP_PROXY e HTTPS_PROXY nell'ambiente del programma binario apigee-remote-service-envoy. Quando le utilizzi, la variabile di ambiente NO_PROXY può essere utilizzata anche per escludere host specifici dall'invio tramite il proxy.

HTTP_PROXY=http://[user]:[pass]@[proxy_ip]:[proxy_port]
HTTPS_PROXY=http://[user]:[pass]@[proxy_ip]:[proxy_port]
NO_PROXY=127.0.0.1,localhost

Ricorda che il proxy deve essere raggiungibile da apigee-remote-service-envoy.

Informazioni su metriche e analisi

Un endpoint delle metriche di Prometheus è disponibile all'indirizzo :5001/metrics. Puoi configurare questo numero di porta. Vedi File di configurazione.

Analisi di Envoy

I seguenti link forniscono informazioni su come ottenere i dati di analisi proxy di Envoy:

Analisi Istio

I seguenti link forniscono informazioni su come ottenere i dati di analisi proxy di Envoy:

Analisi Apigee

Apigee Remote Service for Envoy invia statistiche delle richieste ad Apigee per l'elaborazione delle analisi. Apigee segnala queste richieste sotto il nome del prodotto API associato.

Per informazioni sull'analisi di Apigee, consulta la panoramica dei servizi di analisi.