Guida operativa

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Come ottenere una chiave API

L'esempio seguente spiega come ottenere una chiave API da utilizzare per la convalida Chiamate API a un servizio di destinazione inviate tramite proxy tramite Apigee Adapter for Envoy.

1. Accedi ad Apigee

  1. Apri la UI di Apigee in un browser.
  2. Una volta nella UI, 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 procedendo 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 dello sviluppatore che desideri.

3. Creazione di un prodotto API

Segui l'esempio di creazione del prodotto fornito di seguito. Vedi anche Informazioni su 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 fino a quando non ti viene chiesto di farlo.
    4. Campo Valore
    Nome httpbin-product
    Nome visualizzato httpbin product
    Ambiente your_environment

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

    Accesso Private
    Quota 5 richieste ogni minuto

    Consulta anche Informazioni sulle quote.

  4. Nella sezione Destinazioni di servizio remoto Apigee, fai clic su Aggiungi un target di servizio remoto Apigee.
  5. Nella finestra di dialogo di 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 davanti al proxy Envoy.
    proxy API remote-service Il proxy remote-service di cui è stato eseguito il provisioning su Apigee durante l'installazione dell'adattatore Envoy.
    Percorso Inserisci un /resource_path che corrisponda a un percorso specifico. Per esempio: /httpbin. Il percorso di richiesta per trovare una corrispondenza nell'endpoint di destinazione. Chiamate proxy API a questo percorso corrisponde a questo prodotto API.

    Edge Public o Private Cloud: il seguente screenshot mostra le impostazioni della finestra di dialogo configurate correttamente per l'ambiente httpbin.org di destinazione, una configurazione appropriata 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 dell'app sviluppatore come segue. Non salvare finché non ti viene chiesto di farlo.
    4. Nome httpbin-app
    Nome visualizzato httpbin app
    Developer Seleziona lo sviluppatore che hai creato in precedenza o scegline uno che preferisci dall'elenco.
  4. Successivamente, aggiungi due prodotti all'app:
    1. Nella sezione Credenziali, fai clic su + Aggiungi prodotto e seleziona il prodotto che appena configurato: httpbin-product.
    2. Quindi, aggiungi il prodotto remote-service. Questo prodotto è stato creato automaticamente quando esegui 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 API

I prodotti API sono lo strumento di controllo principale per il servizio remoto Apigee. Quando crei un prodotto API e lo associ a una servizio di destinazione, stai creando un criterio che applicata a tutte le richieste che configuri per Apigee Adapter for Envoy da gestire.

Definizione del prodotto API

Quando definisci un prodotto API in Apigee, puoi impostare una serie di parametri verrà utilizzato per valutare le richieste:

  • Target
  • Percorso richiesta
  • Quota
  • Ambiti OAuth

Target di servizio remoti

La definizione del prodotto API verrà applicata a una richiesta se corrisponde sia al target l'associazione (ad esempio httpbin.org) e il percorso della richiesta (ad esempio /httpbin). Un elenco di potenziali target viene archiviato come attributo nella Prodotto API.

Per impostazione predefinita, il servizio remoto Apigee controlla l'intestazione :authority (host) speciale di Envoy rispetto a il proprio elenco di target; ma può essere configurato per usare altre intestazioni.

Percorso risorsa API

Il percorso inserito corrisponde in base alle seguenti regole:

  • Una barra (/) da sola corrisponde a qualsiasi percorso.
  • * è valido ovunque e corrisponde all'interno di un segmento (tra le 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 le API nell'arco di un'ora, un giorno, una settimana o un mese. Quando un'app raggiunge il limite di quota, le chiamate API successive vengono rifiutate.

Casi d'uso relativi alle quote

Le quote consentono di applicare in modo forzato il numero di richieste che un client può effettuare a un servizio in un un determinato periodo di tempo. Le quote vengono spesso utilizzate per applicare contratti aziendali o SLA con a sviluppatori e partner, non per la gestione operativa del traffico. Ad esempio, un quota potrebbe essere utilizzata per limitare il traffico di un servizio gratuito, consentendo al contempo l'accesso completo clienti paganti.

La quota è definita in un prodotto API

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

Poiché le chiavi API riconnettono ai prodotti API, ogni volta che una chiave API viene verificata, è possibile ridurre il contatore quota appropriato (se è definita una quota nel prodotto associato).

A differenza del runtime Apigee, le quote immesse nella definizione del prodotto sono automaticamente dal servizio remoto Apigee. Se la richiesta è autorizzata, la richiesta verrà conteggiata nella quota consentita.

Dove vengono mantenute le quote

Le quote vengono gestite e controllate localmente dal processo del servizio remoto e in modo asincrono gestito con il runtime Apigee. Ciò significa che le quote non sono precise e probabilmente il superamento della soglia se più di un servizio remoto mantiene la quota. Se la connessione a Apigee Runtime viene interrotta, la quota locale continuerà come autonoma quota finché non sarà in grado di riconnettersi al runtime Apigee.

Ambiti OAuth

Se utilizzi token JWT, puoi limitarli 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 sviluppatore

Dopo aver configurato i tuoi prodotti API, dovrai creare un'app associata a uno sviluppatore. L'app Consente a un client di accedere 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 invece di utilizzare una chiave API. Questo spiega come usare 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 eseguita l'autenticazione, il filtro ext-authz di Envoy invia le intestazioni e il JWT della richiesta a apigee-remote-service-envoy. Corrisponde alle rivendicazioni api_product_list e scope del JWT nei prodotti API Apigee per autorizzarla in base alla destinazione della richiesta.

Creazione di token JWT Apigee in corso...

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, utilizzando l'endpoint del token OAuth standard. Esempio di Curl:

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, è sufficiente 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, potrebbe essere visualizzato un messaggio simile al seguente:

Jwks remote fetch is failed

In questo caso, assicurati che la configurazione di Envoy contenga un URI valido nella sezione remote_jwks, che sia raggiungibile da Envoy e che tu abbia correttamente Impostare i certificati quando hai installato il proxy Apigee. Dovresti riuscire a 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 da Envoy possono avere il seguente aspetto:

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

Si tratta dei requisiti della tua configurazione Envoy che potresti dover modificare.

Ispeziona un token

Puoi utilizzare l'interfaccia a riga di comando per ispezionare 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

Consulta l'articolo Non va a buon fine una chiave API valida.

Logging

Puoi modificare il livello di logging nel servizio $REMOTE_SERVICE_HOME/apigee-remote-service-envoy. Tutti i log vengono inviati a stderr.

Elemento Obbligatorio Descrizione
-l, --log-level Livelli validi: debug, informazioni, avviso, errore. Regola il livello di logging. Valore 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 di Envoy:

Utilizzo di un proxy di rete

È possibile inserire un proxy HTTP utilizzando le variabili di ambiente HTTP_PROXY e HTTPS_PROXY nell'ambiente del file binario apigee-remote-service-envoy. Quando vengono utilizzati, i modelli NO_PROXY può essere utilizzata anche per escludere host specifici dall'invio tramite 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 Prometheus è disponibile all'indirizzo :5001/metrics. Puoi configurare questo numero di porta. Consulta File di configurazione.

Analisi di Envoy

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

Analisi Istio

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

Analisi Apigee

Il servizio remoto Apigee per Envoy invia le statistiche delle richieste ad Apigee per l'elaborazione delle analisi. Apigee segnala queste richieste sotto il nome del prodotto API associato.

Per informazioni su dati e analisi di Apigee, consulta la panoramica dei servizi di analisi.