Gestione dei prodotti API

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza 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 un per una panoramica dei prodotti basati su API, consulta Che cos'è è un prodotto basato su API?

Esplorazione della pagina di riepilogo Prodotti

La pagina Panoramica Prodotti mostra tutti i tuoi prodotti API e alcuni dettagli su ciascuno uno. 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 basati su API. Apigee visualizza Pagina di riepilogo 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 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 supportate 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. Soltanto 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.

  5. 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 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 sulla nuova API prodotto. 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 ad Apigee API 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 la visualizzazione nome 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 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 esistono ambienti specificati, tutti gli ambienti sono consentiti dal prodotto API.

Gli ambienti selezionati in questo campo limitano l'accesso ai proxy API in base in cui viene eseguito il deployment. Ad esempio, se viene eseguito il deployment del proxy API A sia nel server test e prod, ma il prodotto API ha solo test di ambiente selezionato, una chiamata API per l'app sviluppatore corrispondente consente accesso al proxy API A di cui è stato eseguito il deployment nell'ambiente test. Per ulteriori informazioni sugli ambienti, 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 Accesso .
Automatically approve access requests Facoltativo (il valore predefinito è selezionato)

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

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

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:

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

Per ulteriori informazioni, vedi Registrazione in corso app e la 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 operazioni richieste per questo prodotto API.

Questo valore viene sostituito da limiti di quota più specifici impostati per le operazioni sul 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, vedi 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. La suite operativa controllare quali metodi REST e avere accesso a quali i percorsi delle risorse in un prodotto API è possibile effettuare molte chiamate di questo tipo (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 non consentire le richieste a URI specifici. Per Ad esempio, se imposti l'origine dell'operazione sull'API music con un percorso di base /music, il prodotto API consente le chiamate tutti i percorsi secondari in /music. Tuttavia, se desideri che il prodotto API consenta l'accesso solo Percorso della risorsa venues con URI /music/venues, aggiungi /venues come percorso dell'operazione. Puoi farlo per tutte le operazioni oppure per operazioni specifiche.

In questo caso sono consentite le chiamate al numero /music/venues?name=paramount, 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 Configurazione dei 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 richieste al proxy API corrispondenti 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 il valore di questo campo quando salvi l'operazione.

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 grafica. La Viene visualizzata la vista Operazione. Vedi anche Con 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 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 il valore di questo campo quando salvi l'operazione.

Per informazioni sulla funzionalità dei tipi di operazioni GraphQL, vedi Query e mutazioni.
Quota Facoltativo Specifica i limiti di quota per questa operazione. Questa quota prevale su quella impostata 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. La 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 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 operations.

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 suo valore è true, puoi generare un errore con il criterio RaiseFault perché vuoi che l'operazione si comporti come se fosse deprecata e non fosse più supportata.

.

Quota

Definisce le impostazioni della quota a livello di proxy API o nell'ambito dell'operazione. Ci sono tre campi sotto Quota che devi specificare se definisci una quota:

  1. Il primo campo specifica il numero massimo di richieste per consentire l'accesso 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 una quota .

  3. 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 una quota .

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

Aggiungi una nuova quota a un&#39;operazione

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

Aggiungi una nuova quota a un&#39;operazione

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 sulla stessa operativa. 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 solo gli URI di un livello inferiore rispetto al percorso di base sono supportati.
  • 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 percorsi di risorse diversi. In questo esempio, il proxy API ha un percorso di base /v1/weatherapikey. Il percorso della risorsa di prodotto API si applica al suffisso del percorso dopo del 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 se il proxy API è /v1/weatherapikey, il prodotto API supporta le richieste a /v1/weatherapikey ed eventuali percorsi secondari, ad esempio /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e così via.

Con i prodotti basati su API, puoi modificare questa impostazione predefinita in modo che corrisponda a un percorso della risorsa / 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, tabella sopra solo le prime due righe in "Consentito per /" sarebbero consentite.

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 basati su API.
  3. Fai clic nella riga del prodotto API che vuoi modificare. Apigee visualizza i dettagli il 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 l'API risorsa e aggiungi una nuova versione con i valori corretti se vuoi modificarle.

    Potresti eliminare una risorsa se non funziona correttamente o se è necessaria sviluppo del prodotto. 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 rimossi da un prodotto API ma non vengono eliminati dal sistema, quindi possono essere ancora utilizzati con altri prodotti basati su 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. A tale scopo puoi eliminare le app o la revocazione delle chiavi API dell'app.

Per eliminare un prodotto API:

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