Gestisci i prodotti API

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Gestisci i prodotti API utilizzando l'interfaccia utente di gestione di Apigee Edge, come descritto in questa sezione. Per gestire i prodotti API utilizzando l'API, consulta Utilizzo dell'API di gestione Edge per pubblicare le API.

Guarda il seguente video per scoprire come creare un prodotto API.

Per una panoramica dei prodotti API, consulta Che cos'è un prodotto API?.

Esplorare la pagina dei prodotti API

Accedi alla pagina dei prodotti API, come descritto di seguito.

Edge

Per accedere alla pagina dei prodotti API utilizzando l'interfaccia utente di Edge:

  1. Accedi a https://apigee.com/edge.
  2. Seleziona Pubblica > Prodotti API.

Viene visualizzata la pagina Prodotti API.

Pagina Prodotti API che mostra l'elenco dei prodotti API. Sono disponibili callout che mostrano le attività che puoi svolgere, elencate sotto la figura.

Come mostrato nella figura precedente, la pagina dei prodotti API ti consente di eseguire le seguenti attività, descritte più avanti in questa sezione:

Classic Edge (Private Cloud)

Per accedere alla pagina dei prodotti API utilizzando l'interfaccia utente di Classic Edge:

  1. Accedi a http://ms-ip:9000, dove ms-ip è l' indirizzo IP o il nome DNS del nodo del server di gestione.
  2. Seleziona Pubblica > Prodotti.

La pagina dei prodotti API ti consente di eseguire le seguenti attività, descritte più avanti in questa sezione:

Aggiungere un prodotto API

Aggiungi un prodotto API utilizzando l'interfaccia utente, come descritto di seguito. Per utilizzare l'API Edge, consulta Configurare i prodotti API utilizzando l'API.

Per aggiungere un prodotto API utilizzando l'interfaccia utente di Edge:

  1. Accedi alla pagina dei prodotti API, come descritto in precedenza in questa sezione.
  2. Fai clic su +Prodotto API.
  3. Inserisci i dettagli del prodotto per il prodotto API.
    Campo Descrizione
    Nome Nome interno del prodotto API. Non puoi modificare il nome una volta creato il prodotto API. Non specificare caratteri speciali nel nome.
    Nome visualizzato Nome visualizzato del prodotto API. Il nome visualizzato viene utilizzato nell'interfaccia utente e puoi modificarlo in qualsiasi momento. Se non specificato, verrà utilizzato il valore del nome. Questo campo viene compilato automaticamente utilizzando il valore del nome; puoi modificare o eliminare i contenuti. Il nome visualizzato può includere caratteri speciali.
    Descrizione Descrizione del prodotto API.
    Ambiente Ambienti a cui il prodotto API consentirà l'accesso. Ad esempio, test o prod.
    Accesso Livello di accesso. Per i dettagli, vedi Livello di accesso.
    Approva automaticamente le richieste di accesso Consenti l'approvazione automatica delle richieste di chiavi per questo prodotto API da qualsiasi app. Per richiedere l'approvazione manuale delle chiavi, disattiva questa opzione. Consulta Registrare le app e gestire le chiavi API (interfaccia utente) e Chiavi delle app per sviluppatori (API).
    Quota Limite di quota a cui vuoi fare riferimento dai criteri relativi alle quote. L'inserimento di un valore di quota non applica automaticamente le limitazioni al numero di chiamate che possono essere effettuate tramite il prodotto. I proxy API a cui fa riferimento il prodotto devono includere il criterio relativo alle quote per applicare la quota. Per scoprire di più, consulta Quote.
    Ambiti OAuth consentiti Se utilizzi OAuth con il prodotto API, gli ambiti OAuth consentiti che vuoi che il prodotto API consenta (ad esempio Read o altri ambiti che le app invieranno con le chiamate API). Specifica più ambiti come elenco separato da virgole. Consulta Ambiti OAuth.

  4. Aggiungi le risorse API disponibili nel prodotto API, inclusi i proxy API e i percorsi delle risorse.

    Ad esempio, se aggiungi un proxy API "music" al prodotto con un percorso di base /music, il prodotto API consente le chiamate a /music. Tuttavia, se vuoi che il prodotto API consenta l'accesso solo al percorso della risorsa venues, che ha un URI /music/venues, aggiungi il percorso della risorsa /venues al prodotto. In questo caso, le chiamate a /music/venues?name=paramount sono consentite, ma le chiamate a /music/artists?name=Jack%Johnson verranno bloccate.

    Imposta un percorso della risorsa specifico o imposta il percorso di base e tutti i possibili sottopercorsi specificando il percorso della risorsa come /. Il percorso della risorsa può includere i caratteri jolly /** e /*. Il carattere jolly con doppio asterisco indica che tutti i sottopercorsi del percorso di base sono supportati (ma non il percorso di base). Un singolo asterisco indica che sono supportati solo gli URI di un livello inferiore rispetto al percorso di base. Consulta Configurare il comportamento del percorso della risorsa di '/', '/*' e '/**', come descritto più avanti in questa sezione.

    Per aggiungere risorse API:

    1. Fai clic su Aggiungi un proxy o Aggiungi un percorso nella sezione Risorse API.
    2. Scegli se vuoi aggiungere un proxy API, un percorso o entrambi proxy API e percorso.

      La sezione Aggiungi risorsa API ti consente di aggiungere un proxy API, un percorso della risorsa o entrambi.

    3. Aggiungi uno o più proxy API e percorsi delle risorse.

      Tieni presente quanto segue:

      • I percorsi delle risorse che definisci 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; il percorso della risorsa /** verrà ignorato.

      Ad esempio:

      Il percorso della risorsa applicato a tutti i proxy API e il percorso della risorsa più specifico viene ignorato

    4. Fai clic su Aggiungi o Aggiungi e avvia un altro (per specificare altre risorse API).
  5. (Facoltativo) Utilizza la sezione Target del servizio remoto Apigee per associare il prodotto a uno o più target del servizio remoto. A meno che tu non stia utilizzando l'adattatore Apigee Envoy, puoi ignorare questa impostazione. Per saperne di più, consulta la Guida operativa per l'adattatore Apigee Envoy.

  6. (Facoltativo) Utilizza la sezione Attributi personalizzati per aggiungere fino a 18 attributi personalizzati a un prodotto API.

    Gli attributi personalizzati sono coppie chiave/valore che possono essere utilizzate in molti modi, incluso il controllo dell'esecuzione del proxy API. Ad esempio, puoi creare un attributo personalizzato denominato deprecated con un valore true o false. Nel flusso del proxy API, puoi controllare il valore dell'attributo deprecated del prodotto API (ad esempio, utilizzando la variabile verifyapikey.{policy_name}.apiproduct.deprecated disponibile automaticamente dopo aver creato l'attributo personalizzato). Se il suo valore è true (deprecato), puoi generare un errore con il criterio Raise Fault.

  7. Fai clic su Salva.

Configurare il comportamento di un percorso della risorsa di '/', '/*' e '/**'

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

URI della richiesta Consentiti per / Consentiti per /* Consentiti per /** Consentiti per /*/2/** Consentiti per /*/2/*

/v1/weatherapikey

Y

N

N

N

N

/v1/weatherapikey/

Y

N

N

N

N

/v1/weatherapikey/1

Y

S

Y

N

N

/v1/weatherapikey/1/

Y

S

Y

N

N

/v1/weatherapikey/1/2

Y

N

S

N

N

/v1/weatherapikey/1/2/

Y

N

Y

Y

N

/v1/weatherapikey/1/2/3/

Y

N

Y

S

Y

/v1/weatherapikey/1/a/2/3/

Y

N

S

N

N

Per impostazione predefinita, un percorso della risorsa / in un prodotto API supporta il percorso di base e tutti i sottopercorsi. 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 sottopercorsi, come /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e così via.

Puoi modificare questa impostazione predefinita in modo che un percorso della risorsa / corrisponda solo al percorso di base del proxy API, il che significa che il prodotto API non consentirà l'accesso a un URI che contiene qualcosa dopo /. Se apporti questa modifica, nella tabella sopra, solo le prime due righe sotto "Consentiti per /" conterranno "Y".

Per modificare l'impostazione predefinita, un amministratore di sistema deve impostare il valore della features.isSingleForwardSlashBlockingEnabled proprietà della tua organizzazione su true. I clienti Cloud possono inviare questa richiesta a Apigee Edge Support.

Modificare un prodotto API

Per modificare un prodotto API:

  1. Accedi alla pagina dei prodotti API, come descritto in precedenza in questa sezione.
  2. Fai clic sulla riga del prodotto API che vuoi modificare.
  3. Fai clic su Modifica nella pagina del prodotto API.
  4. Modifica i campi in base alle esigenze.

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

  5. Fai clic su Salva.

Con Apigee Edge for Public Cloud, Edge mantiene le seguenti entità nella cache per un minimo di 180 secondi dopo che le entità sono state accessibili.

  • Token di accesso OAuth. Ciò significa che un token revocato potrebbe comunque funzionare per un massimo di tre minuti, fino alla scadenza del limite della cache.
  • Entità di Key Management Service (KMS) (app, sviluppatori, prodotti API).
  • Attributi personalizzati su token OAuth ed entità KMS.

Eliminare un prodotto API

Prima di poter eliminare un prodotto API, devi annullare la registrazione/l'associazione di tutte le app per sviluppatori associate al prodotto. Puoi farlo eliminando le app o revocando le chiavi API delle app.

Per eliminare un prodotto API:

  1. Accedi alla pagina dei prodotti API, come descritto in precedenza in questa sezione.
  2. Posiziona il cursore sul prodotto API nell'elenco.
  3. Fai clic su Icona Elimina.
  4. Fai clic su Elimina per confermare l'operazione di eliminazione.