Gestione dei prodotti API

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

I prodotti basati su API raggruppano le tue API e le rendono disponibili per il consumo da parte degli sviluppatori di app. Per una panoramica dei prodotti basati sulle API, vedi Che cos'è un prodotto API?

Esplorazione della pagina di riepilogo Prodotti

La pagina Panoramica Prodotti mostra tutti i tuoi prodotti API e alcuni dettagli su ciascuno. In questa pagina puoi creare un nuovo prodotto API, eliminare un prodotto o selezionarne uno da visualizzare o modificare.

Per accedere alla Panoramica dei prodotti:

L'interfaccia utente Prodotti consente di eseguire le seguenti attività comuni:

Queste attività sono descritte nelle sezioni seguenti.

Creazione di un prodotto API

Questa sezione descrive come creare un prodotto API utilizzando la UI di Apigee.

Per creare un prodotto API utilizzando la UI di Apigee:

  2. Seleziona Pubblica > Prodotti API. Apigee visualizza la pagina di panoramica Prodotti.
  3. Fai clic su + Crea. Viene visualizzata la pagina di configurazione del prodotto.
  4. Configura il prodotto API. Le parti della pagina di configurazione del prodotto includono quanto segue:
    • Dettagli del prodotto: informazioni di base sul prodotto API, come nome, livello di accesso (privato, pubblico o interno) e ambiti OAuth.
    • Operazioni:gruppi di proxy API, percorsi di risorse e metodi HTTP supportati da questo prodotto API. Puoi anche definire i limiti delle quote per ogni operazione.
    • Operazioni GraphQL: gruppi di proxy API, percorsi delle risorse e tipi di operazioni GraphQL supportati da questo prodotto API. I tipi di operazioni GraphQL supportati includono query e mutazioni. Puoi specificare uno dei due tipi o entrambi. Come per i proxy API basati su REST, puoi definire limiti di quota per ogni operazione.
    • Operazioni gRPC: specifica i proxy API gRPC e i metodi gRPC supportati da questo prodotto API. Come per i proxy API basati su REST, puoi definire limiti di quota per le operazioni.
    • Attributi personalizzati: coppie chiave/valore che consentono di controllare l'esecuzione del proxy API.

    Ognuna di queste parti principali è descritta nelle sezioni seguenti.

  5. Quando hai terminato, fai clic su Salva. Apigee crea il nuovo prodotto API. Ora puoi collegare il prodotto a un'app per sviluppatori. Consulta Controllo dell'accesso alle API tramite la registrazione delle app. Per ulteriori esempi, consulta Proteggere un'API richiedendo chiavi API e Proteggere un'API con OAuth.

Dettagli del prodotto

Nella sezione Dettagli prodotto, inserisci le informazioni di base sul nuovo prodotto API. Nella tabella seguente vengono descritti i campi di questa sezione:

Campo Obbligatorio? Descrizione
Name Obbligatorio

Definisce il nome interno del prodotto API. Questo valore viene utilizzato nelle chiamate all'API Apigee che fanno riferimento al prodotto API. Il valore del campo Name può includere caratteri alfanumerici, spazi e quanto segue: _ - . # $ %

Ad esempio, My API Product o my-product.
Display name Obbligatorio

Definisce il nome utilizzato nella UI di Apigee per il prodotto API. Puoi modificare il nome visualizzato del prodotto API in qualsiasi momento.

Il campo Display name può includere caratteri speciali.

Ad esempio, <My> API Product!!!.
Description Facoltativo

Una stringa che può aiutarti a ricordare lo scopo o la funzione del prodotto API. La descrizione può includere caratteri speciali.

Ad esempio, The one where I let dev apps read but not write to the "/accounts" endpoints.
Environment Facoltativo

Identifica gli ambienti a cui il prodotto API consente l'accesso. Se non viene specificato nessun ambiente, tutti gli ambienti sono consentiti dal prodotto API.

Gli ambienti selezionati in questo campo limitano l'accesso ai proxy API in base a dove ne viene eseguito il deployment. Ad esempio, se viene eseguito il deployment del proxy API A in entrambi gli ambienti test e prod, ma per il prodotto API è selezionato solo l'ambiente test, una chiamata API per l'app sviluppatore corrispondente consente l'accesso solo al proxy API A di cui è stato eseguito il deployment nell'ambiente test. Per saperne di più sugli ambienti, consulta Informazioni sugli ambienti e sui gruppi di ambienti.
Access Obbligatorio Il livello di accesso assegnato agli utenti di questo prodotto API. Per maggiori dettagli, vedi Livelli di accesso.
Automatically approve access requests Facoltativo (il valore predefinito è selezionato)

Abilita l'approvazione automatica delle richieste di chiavi in arrivo per questo prodotto API da qualsiasi app. Per richiedere l'approvazione manuale della chiave, disabilita questa opzione.

L'impostazione predefinita è selezionata, il che significa che questo prodotto API approva automaticamente le richieste chiave.

Se selezioni l'approvazione manuale della chiave, devi approvare le richieste chiave provenienti da qualsiasi app che utilizza questo prodotto API. Per approvare manualmente le chiavi:

  • Interfaccia utente: seleziona Pubblica > App, quindi seleziona l'app e modificala. Quindi, fai clic su Approva.
  • API: usa l'API Developer app Keys.

Per maggiori informazioni, consulta Registrazione delle app e gestione delle chiavi API.
Quota Facoltativo

Definisce i limiti al numero di richieste consentite per questo prodotto API. Questo valore si applica alla somma di tutte le richieste delle operazioni per questo prodotto API.

Questo valore viene sostituito da limiti di quota più specifici impostati per le operazioni che definisci sul prodotto API.

L'inserimento di un valore di quota non applica automaticamente limitazioni al numero di chiamate che è possibile effettuare tramite il prodotto API. Devi anche aggiungere il criterio per le quote ai proxy API a cui fa riferimento il prodotto API.

Per maggiori informazioni, consulta Quote.
Allowed OAuth scope Facoltativo Se utilizzi OAuth con il prodotto API, inserisci un elenco separato da virgole di ambiti OAuth che il prodotto API deve consentire (ad esempio, Lettura o altri ambiti che le app inviano con le loro chiamate API). Per maggiori informazioni, consulta Ambiti OAuth.

Suite operativa

Specifica le operazioni consentite su un proxy API basato su HTTP, inclusi percorsi delle risorse, metodi HTTP e quote. Le operazioni consentono di controllare quali metodi REST e di avere accesso a quali percorsi delle risorse in un prodotto API e quante chiamate di questo tipo possono essere effettuate (con la quota).

Per configurare i dettagli dell'operazione, fai clic su + AGGIUNGI UN'OPERAZIONE nella sezione Operazioni. Viene visualizzata la vista Operazione.

Campo Obbligatorio? Descrizione
API proxy Obbligatorio

Seleziona il proxy API da associare a questa operazione.
Path Obbligatorio

Inserisci il percorso della risorsa per l'operazione.

Puoi utilizzare il percorso dell'operazione per consentire o non consentire le richieste a URI specifici. Ad esempio, se imposti l'origine dell'operazione sul proxy API music con un percorso di base /music, il prodotto API consente le chiamate a tutti i percorsi secondari in /music. Tuttavia, se vuoi che il prodotto API consenta l'accesso solo al percorso della risorsa venues che ha un URI /music/venues, aggiungi /venues come percorso dell'operazione. Puoi farlo per tutte le operazioni o per operazioni specifiche.

In questo caso, le chiamate al numero /music/venues?name=paramount sono consentite, ma le chiamate al numero /music/artists?name=Jack%Johnson sono bloccate.

Tieni presente che esistono regole speciali per i caratteri jolly nei percorsi delle risorse, come descritto in Configurare i percorsi delle risorse.
Methods Facoltativo

Seleziona uno o più metodi di richiesta HTTP dall'elenco a discesa. Questi metodi sono a volte noti come verbi HTTP. Apigee consente le richieste al proxy API che corrispondono solo ai metodi selezionati.

L'impostazione predefinita è "Nessuna selezione", che consente le richieste con qualsiasi metodo HTTP.

Se non selezioni almeno un metodo, Apigee inserisce ALL come valore di questo campo quando salvi l'operazione.

Per informazioni sulla funzionalità dei metodi di richiesta HTTP, consulta Metodi di richiesta HTTP.
Quota Facoltativo Specifica i limiti di quota per questa operazione. Per maggiori dettagli su come vengono conteggiate le quote, consulta Informazioni sui contatori delle quote.
Custom attributes Facoltativo Consulta Attributi personalizzati.

Operazioni GraphQL

Per configurare i dettagli dell'operazione GraphQL, fai clic su + AGGIUNGI UN'OPERAZIONE nella sezione Operazioni grafica. Viene visualizzata la vista Operazione. Vedi anche Utilizzo di GraphQL.

Campo Obbligatorio? Descrizione
API proxy Obbligatorio

Seleziona il proxy API da associare a questa operazione.
Operation name Obbligatorio

Specifica un nome per l'operazione
Operation type Facoltativo

Seleziona uno o più tipi di operazioni GraphQL dall'elenco a discesa. Apigee consente al proxy API richieste che corrispondono solo ai tipi di operazioni selezionati.

L'impostazione predefinita è nessuna selezione e consente richieste con qualsiasi tipo di operazione.

Se non selezioni almeno un tipo, Apigee inserisce ALL come valore di questo campo quando salvi l'operazione.

Per informazioni sulla funzionalità dei tipi di operazioni GraphQL, consulta Query e mutazioni.
Quota Facoltativo Specifica i limiti di quota per questa operazione. Questa quota sostituisce quella impostata per il prodotto API. Consulta Quota.
Custom attributes Facoltativo Consulta Attributi personalizzati.

Operazioni gRPC

Per configurare i dettagli dell'operazione gRPC, fai clic su + AGGIUNGI UN'OPERAZIONE nella sezione Operazioni gRPC. Viene visualizzata la vista Operazione. Vedi anche Creazione di proxy API gRPC.

Campo Obbligatorio? Descrizione
API proxy Obbligatorio

Seleziona il proxy API da associare a questa operazione.
Service name Obbligatorio

Specifica un nome per l'operazione.

Per la release corrente, non è disponibile un'opzione per fornire il nome del server di destinazione. Il nome del servizio e il server di destinazione sono uguali.

gRPC methods in service Facoltativo

Inserisci i metodi gRPC disponibili utilizzando un elenco separato da virgole per più metodi.

Quota Facoltativo Specifica i limiti di quota per queste operazioni. Questa quota sostituisce quella impostata per il prodotto API. Consulta Quota.
Custom attributes Facoltativo Consulta Attributi personalizzati.

Attributi personalizzati

Gli attributi personalizzati sono coppie chiave/valore che possono essere utilizzate in molti modi, ad esempio per controllare l'esecuzione del proxy API.

In totale, un prodotto API può avere fino a 18 attributi personalizzati, inclusi quelli impostati per le operazioni.

Ad esempio, puoi creare un attributo personalizzato denominato deprecated con un valore pari a true o false. Nel flusso del proxy API, puoi controllare il valore dell'attributo deprecated del prodotto API. Se il valore è true, puoi generare un errore con il criterio RaiseFault perché vuoi che l'operazione si comporti come se fosse deprecata e non più supportata.

Quota

Definisce le impostazioni della quota a livello di proxy API o nell'ambito dell'operazione. Se definisci una quota, devi specificare tre campi in Quota:

  1. Il primo campo specifica il numero massimo di richieste da consentire da un'app sviluppatore al proxy API per il periodo specificato.

    Questo campo corrisponde all'elemento <Allow> di un criterio per le quote.

  2. Il secondo campo specifica la frequenza (o l'intervallo) di reimpostazione della quota.

    Questo campo corrisponde all'elemento <Interval> in un criterio per le quote.

  3. Il terzo campo specifica il type (o unità di tempo) del periodo reimpostato, ad esempio giorno, settimana o mese.

    Questo campo corrisponde all'elemento <TimeUnit> in un criterio per le quote.

L'esempio seguente imposta un limite di 1000 richieste GET, HEAD e TRACE al giorno al proxy API (tutte le altre richieste HTTP vengono ignorate):

Aggiungi una nuova quota a un&#39;operazione

L'esempio seguente imposta un limite di 42 richieste ogni 3 minuti, indipendentemente dal metodo HTTP, per la risorsa /mypath:

Aggiungi una nuova quota a un&#39;operazione

Quando definisci una quota per un'operazione, devi inserire i valori per tutti e tre i campi nella sezione Quota.

Non puoi definire quote diverse per più metodi HTTP nella stessa operazione. Per farlo, devi creare più prodotti API e definire le quote specifiche del metodo su ciascuno.

Se imposti questi valori sia nei criteri per le quote sia nel prodotto API (nella UI come descritto qui o con l'API dei prodotti API, le impostazioni interfaccia utente/API del prodotto API hanno la precedenza.

Configurazione dei percorsi delle risorse

Tieni presente le seguenti regole per i percorsi delle risorse:

  • /: indica che il percorso di base e tutti i relativi percorsi secondari sono supportati.
  • /**: indica che sono supportati tutti i percorsi secondari del percorso di base, ma non quello di base.
  • /*: indica che sono supportati solo gli URI di un livello inferiore rispetto al percorso di base.
  • I percorsi di risorse specificati nel prodotto API o nelle sue operazioni si applicano a tutti i proxy API aggiunti al prodotto API.
  • I percorsi delle risorse più inclusivi e meno specifici hanno la precedenza su quelli più specifici. Ad esempio, se aggiungi / e /**, il percorso della risorsa / ha la precedenza, mentre il percorso della risorsa /** viene ignorato.

La tabella seguente mostra il comportamento predefinito di un prodotto API per i diversi percorsi delle risorse. In questo esempio, il proxy API ha un percorso di base di /v1/weatherapikey. Il percorso della risorsa del prodotto API si applica al suffisso del percorso dopo il percorso di base.

URI di richiesta Consentito per / Consentito per /* Consentito per /** Consentito per /*/2/** Consentito per /*/2/*
/v1/weatherapikey
/v1/weatherapikey/
/v1/weatherapikey/1
/v1/weatherapikey/1/
/v1/weatherapikey/1/2
/v1/weatherapikey/1/2/
/v1/weatherapikey/1/2/3/
/v1/weatherapikey/1/a/2/3/

Per impostazione predefinita, un percorso della risorsa / in un prodotto API supporta il percorso di base e tutti i percorsi secondari. Ad esempio, se il percorso di base del proxy API è /v1/weatherapikey, il prodotto API supporta le richieste a /v1/weatherapikey e a tutti i percorsi secondari, come /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e così via.

Con i prodotti API, puoi modificare questa impostazione predefinita in modo che un percorso della risorsa / corrisponda solo al percorso di base del proxy API. Ciò significa che il prodotto API non consentirà l'accesso a un URI contenente qualsiasi elemento successivo a /. Se apporti questa modifica, nella tabella sopra sono consentite solo le prime due righe sotto "Consentito per /".

Per ulteriori informazioni, consulta la pagina Come funziona la configurazione del prodotto API

Modifica di un prodotto API

Per modificare un prodotto API:

  2. Seleziona Pubblica > Prodotti API.
  3. Fai clic nella riga del prodotto API che vuoi modificare. Apigee visualizza i dettagli del prodotto API.
  4. Fai clic su MODIFICA.

  5. Modifica le impostazioni del prodotto API, se necessario.

    Non puoi modificare una risorsa API esistente. Devi invece eliminare la risorsa API e aggiungere una nuova versione con i valori corretti se vuoi modificarla.

    Potresti eliminare una risorsa se non funziona correttamente o richiede ulteriore sviluppo. Una volta eliminata, la risorsa non fa più parte del prodotto API corrente. Qualsiasi app che utilizza il prodotto API non può più accedere alla risorsa eliminata. Le risorse eliminate vengono rimosse da un prodotto API, ma non vengono eliminate dal sistema, quindi possono essere ancora utilizzate da altri prodotti API.

  6. (Facoltativo) Se la monetizzazione Apigee è abilitata, crea un piano tariffario per il prodotto API facendo clic su Aggiungi.

  7. Fai clic su Salva.

    Le modifiche diventeranno effettive entro un breve periodo di tempo (circa cinque minuti).

Eliminazione di un prodotto API

Prima di poter eliminare un prodotto API, devi annullare la registrazione o l'annullamento dell'associazione di qualsiasi app sviluppatore associata al prodotto. Puoi farlo eliminando le app o revocando le chiavi API delle app.

Per eliminare un prodotto API:

  2. Seleziona Pubblica > Prodotti API.
  3. Apri il menu Azioni nella riga del prodotto da eliminare e seleziona Elimina.
  4. Dopo aver confermato l'operazione di eliminazione, questa diventa effettiva entro un breve periodo di tempo (circa cinque minuti).