Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
I prodotti API raggruppano le tue API e le rendono disponibili per il consumo da parte degli sviluppatori di app. Per un per una panoramica dei prodotti basati su API, consulta Che cos'è è un prodotto basato su API?
Esplorazione della pagina Panoramica dei prodotti
La pagina di panoramica Prodotti mostra tutti i prodotti API e alcuni dettagli su ciascuno. In questa pagina puoi creare un nuovo prodotto API, eliminarne uno o selezionarne uno da visualizzare o modificare.
Per accedere alla Panoramica dei prodotti:
- Se utilizzi l'interfaccia utente di Apigee nella console Cloud: seleziona Distribuzione > Prodotti API.
- Se utilizzi la UI Apigee classica: seleziona Pubblica > Prodotti API.
L'interfaccia utente Prodotti consente di eseguire le seguenti attività comuni:
- Aggiungere un prodotto API
- Modificare un prodotto API
- Cercare nell'elenco dei prodotti API
- Eliminare un prodotto API
Queste attività sono descritte nelle sezioni seguenti.
Creazione di un prodotto API
Questa sezione descrive come creare un prodotto API utilizzando le UI di Apigee.
Per creare un prodotto API utilizzando l'interfaccia utente di Apigee:
- Se utilizzi la UI di Apigee nella console Cloud, seleziona Distribution > API prodotti. Se utilizzi la UI Apigee classica, seleziona Pubblica > Prodotti API.
- Apigee visualizza la pagina di riepilogo Prodotti.
- Fai clic su + Crea. Viene visualizzata la pagina di configurazione del prodotto.
- Configura il prodotto API. Le parti della pagina di configurazione del prodotto includono quanto segue:
- Dettagli prodotto: informazioni di base sul prodotto API, ad esempio i suoi nome, livello di accesso (privato, pubblico o interno) e ambiti OAuth.
- Operazioni: gruppi di proxy API, percorsi delle risorse e metodi HTTP supportati da questo prodotto API. Puoi anche definire i limiti delle quote per operativa.
- Operazioni GraphQL: gruppi di proxy API, percorsi delle risorse e operazioni GraphQL Tipi supportate da questo prodotto API. I tipi di operazioni GraphQL supportati includono query e mutazioni. Puoi specificare un tipo o l'altra, o entrambe. Esattamente come per i servizi basati su REST Con i proxy API puoi definire limiti di quota per ogni operazione.
- Operazioni gRPC: specifica i proxy API gRPC e 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 il proxy API. dell'esecuzione.
Ognuna di queste parti principali è descritta nelle sezioni seguenti.
- Quando hai terminato, fai clic su Salva. Apigee crea il nuovo prodotto API. Ora puoi collegare il prodotto a un'app sviluppatore. Consulta Controllo dell'accesso alle API tramite la registrazione delle app. Per altri esempi, consulta Proteggere un'API richiedendo le 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. Utilizza questo valore nelle chiamate all'API Apigee
che fanno riferimento al prodotto API. Il valore del campo Ad esempio, |
Display name |
Obbligatorio |
Definisce il nome utilizzato nell'interfaccia utente di Apigee per il prodotto API. Puoi modificare la visualizzazione nome del prodotto API in qualsiasi momento. Il campo Ad esempio, |
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, |
Environment |
Facoltativo |
Identifica gli ambienti a cui il prodotto API consente l'accesso. Se non vengono specificati ambienti, tutti gli ambienti sono consentiti dal prodotto API. Gli ambienti selezionati in questo campo limitano l'accesso ai proxy API in base al loro deployment. Ad esempio, se il proxy API A viene eseguito sia nell'ambiente |
Access |
Obbligatorio | Il livello di accesso assegnato agli utenti di questo prodotto API. Per maggiori dettagli, consulta Livelli di accesso. |
Automatically approve access requests |
Facoltativo (il valore predefinito è selezionato) |
Attiva l'approvazione automatica delle richieste di chiavi inviate per questo prodotto API da qualsiasi app. Per richiedere l'approvazione manuale delle chiavi, disattiva questa opzione. È selezionato il valore predefinito, il che significa che questo prodotto API approva automaticamente le richieste di chiave. Se selezioni l'approvazione manuale delle chiavi, devi approvare le richieste chiave provenienti da qualsiasi che utilizza questo prodotto API. Per approvare manualmente le chiavi:
Per ulteriori 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 di operazioni per questo prodotto API. Questo valore viene sostituito da limiti di quota più specifici impostati sulle operazioni che definisci nel prodotto API. L'inserimento di un valore di quota non applica automaticamente limitazioni al numero di chiamate che possono essere effettuate tramite il prodotto API. Devi anche aggiungere i criteri per le quote a Proxy API a cui fa riferimento il prodotto API. Per ulteriori informazioni, consulta Quote. |
Allowed OAuth scope |
Facoltativo | Se utilizzi OAuth con il prodotto API, inserisci un elenco di OAuth separato da virgole gli ambiti che il prodotto API deve consentire (ad esempio quelli di lettura o altri ambiti inviati dalle app con le relative chiamate API). Per ulteriori informazioni, vedi Ambiti OAuth. |
Operazioni
Specifica le operazioni consentite su un proxy API basato su HTTP, inclusi percorsi delle risorse, metodi HTTP e quote. Le operazioni ti consentono di controllare quali metodi REST hanno accesso a quali percorsi delle risorse in un prodotto API e quante chiamate di questo tipo possono essere effettuate (con Quota).
Per configurare i dettagli dell'operazione, fai clic su + AGGIUNGI UN'OPERAZIONE nella sezione Operazioni. La 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 meno le richieste a URI specifici. Ad esempio, se imposti l'origine dell'operazione sul proxy dell'API In questo caso, le chiamate a 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 nell'elenco a discesa. (Questi metodi sono a volte noti come verbi HTTP.) Apigee consente richieste al proxy API corrispondenti solo ai metodi selezionati. Il valore predefinito è nessuna selezione, che consente le richieste con qualsiasi metodo HTTP. Se non selezioni almeno un metodo, Apigee inserisce Per informazioni sulla funzionalità dei metodi di richiesta HTTP, vedi 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 GraphQL. Viene visualizzata la visualizzazione Operazione. Consulta anche Utilizzare 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 richieste al proxy API 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 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 la quota impostata sul 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 visualizzazione 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 versione corrente, non è possibile 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 prevale su quella impostata 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: contribuendo a controllare l'esecuzione del proxy API.
In totale, un prodotto API può avere fino a 18 attributi personalizzati, inclusi quelli impostati sulle operazioni.
Ad esempio, puoi creare un attributo personalizzato denominato deprecated con un valore di 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 di quota a livello di proxy API o ambito dell'operazione. Se definisci una quota, in Quota devi specificare tre campi:
Il primo campo specifica il numero massimo di richieste da consentire da un'app per sviluppatori al proxy API per il periodo specificato.
Questo campo corrisponde all'elemento
<Allow>in un criterio di quota.Il secondo campo specifica la frequenza (o l'intervallo) di reimpostazione della quota.
Questo campo corrisponde all'elemento
<Interval>in un criterio di quota.Il terzo campo specifica il type del periodo di reimpostazione (o unità di tempo), come come giorno, settimana o mese.
Questo campo corrisponde all'elemento
<TimeUnit>in un criterio di quota.
L'esempio seguente imposta un limite di 1000 richieste GET, HEAD e
TRACE al proxy API al giorno (tutte le altre richieste HTTP
vengono ignorate):
L'esempio seguente imposta un limite di 42 richieste ogni 3 minuti, indipendentemente dal
HTTP alla risorsa /mypath:
Quando definisci una quota per un'operazione, devi inserire i valori per tutte tre campi nella sezione Quota.
Non puoi definire quote diverse per più metodi HTTP nella stessa operazione. Per farlo, devi creare più prodotti basati su API e definire i specifiche per ciascun metodo.
Se imposti questi valori sia nel criterio per le quote sia nel prodotto API (nella UI come descritto qui o con l'API dei prodotti API, le impostazioni dell'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 tutti i percorsi secondari del percorso di base sono supportati (ma non il percorso di base)./*: indica che sono supportati solo gli URI a un livello sotto il percorso di base.- I percorsi delle risorse specificati nel prodotto API o nelle relative 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 che sono
più specifiche. Ad esempio, se aggiungi
/e/**, il parametro Il percorso della risorsa/ha la precedenza, mentre il percorso della risorsa/**è ignorato.
La tabella seguente mostra il comportamento predefinito di un prodotto API per diversi percorsi delle risorse. In questo esempio, il proxy API ha un percorso di base di
/v1/weatherapikey. Il percorso della risorsa del prodotto dell'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 eventuali percorsi secondari, come /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e così via.
Con i prodotti API, puoi modificare questo valore predefinito 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 dopo /. Se apporti questa modifica, nella tabella sopra riportata saranno consentite solo le prime due righe in "Consentite per /".
Per ulteriori informazioni, consulta Informazioni sulla configurazione dei prodotti dell'API
Modifica di un prodotto API
Per modificare un prodotto API:
- Se utilizzi la UI di Apigee nella console Cloud, seleziona Distribution > API prodotti. Se utilizzi la UI di Apigee classica, seleziona Pubblica > API Prodotti.
- Seleziona Pubblica > Prodotti basati su API.
- Fai clic nella riga del prodotto API che vuoi modificare. Apigee visualizza i dettagli il prodotto API.
- Fai clic su MODIFICA.
-
Modifica le impostazioni del prodotto API, se necessario.
Non puoi modificare una risorsa API esistente. Devi invece eliminare l'API risorsa e aggiungi una nuova versione con i valori corretti se vuoi modificarle.
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 dal sistema, pertanto possono essere ancora utilizzate da altri prodotti API.
- (Facoltativo) Se la monetizzazione Apigee è abilitata, crea un piano tariffario per il prodotto API
facendo clic su Aggiungi piano tariffario o su
(UI classica). -
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/dissociare tutte le app per sviluppatori associate al prodotto. A tale scopo puoi eliminare le app o la revocazione delle chiavi API dell'app.
Per eliminare un prodotto API:
- Se utilizzi la UI di Apigee nella console Cloud, seleziona Distribution > API prodotti. Se utilizzi la UI Apigee classica, seleziona Pubblica > Prodotti API.
- Seleziona Pubblica > Prodotti basati su API.
- Apri il menu Azioni nella riga del prodotto da eliminare e seleziona Elimina.
- Dopo aver confermato l'operazione di eliminazione, questa viene applicata entro un breve periodo di tempo (circa cinque minuti).