Gestisci i prodotti API

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

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

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

Esplorare la pagina dei prodotti API

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

Aggiunta di un prodotto API

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

Per aggiungere un prodotto API utilizzando l'interfaccia utente 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 dopo aver 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 Nome. Questo campo viene compilato automaticamente utilizzando il valore Nome; puoi modificarne o eliminarne 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 maggiori dettagli, vedi Livello di accesso.
   Approva automaticamente le richieste di accesso	Attiva 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 gli articoli Registrazione di app e gestione delle chiavi API (UI) e Chiavi dell'app per sviluppatori (API).
   Quota	Limite di quota a cui vuoi fare riferimento dai criteri per le quote. L'inserimento di un valore di quota non applica automaticamente limitazioni al numero di chiamate che è possibile effettuare tramite il prodotto. I proxy API a cui fa riferimento il prodotto devono includere i criteri per le quote per applicare la quota. Per saperne di più, consulta Quote.
   Ambiti OAuth consentiti	Se utilizzi OAuth con il prodotto API, specifica gli ambiti OAuth consentiti che vuoi siano consentiti dal prodotto API (ad esempio Lettura o altri ambiti che le app invieranno con le loro chiamate API). Specifica più ambiti come elenco separato da virgole. Vedi Ambiti OAuth.

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

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

   Imposta un percorso di risorsa specifico o imposta il percorso di base e tutti i possibili percorsi secondari specificando il percorso della risorsa come /. Il percorso della risorsa può includere i caratteri jolly /** e /*. Il carattere jolly con doppio asterisco indica che sono supportati tutti i percorsi secondari del percorso di base (ma non il percorso di base). Un singolo asterisco indica che sono supportati solo gli URI a un livello inferiore rispetto al percorso di base. Vedi Configurazione del comportamento del percorso della risorsa "/", "/*" 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 aggiungere un proxy API, un percorso o sia un proxy che un percorso dell'API.

      

   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 di 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 /** verrà ignorato.

      Ad esempio:

      

   4. Fai clic su Aggiungi o Aggiungi e avvia un altro (per specificare risorse aggiuntive dell'API).
5. (Facoltativo) Utilizza la sezione Target di servizio remoto Apigee per associare il prodotto a uno o più target di servizio remoti. A meno che non utilizzi Apigee Envoy Adapter, puoi ignorare questa impostazione. Per ulteriori informazioni, consulta la guida operativa di Apigee Envoy Adapter.

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 utilizzabili in molti modi, ad esempio aiutando a controllare l'esecuzione del proxy API. Ad esempio, potresti creare un attributo personalizzato denominato deprecated con il valore true o false. Nel flusso 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 la creazione dell'attributo personalizzato). Se il valore è true (deprecato), puoi generare un errore con il criterio di generazione degli errori.

7. Fai clic su Salva.

Configurazione del comportamento di un percorso risorsa di "/", "/*" e "/**"

La seguente tabella descrive 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 della richiesta	Consentito per /	Consentito per /*	Consentito per /**	Consentito per /*/2/**	Consentito per /*/2/*
/v1/weatherapikey	Y	No	No	No	No
/v1/weatherapikey/	Y	No	No	No	No
/v1/weatherapikey/1	Y	Y	S	No	No
/v1/weatherapikey/1/	Y	Y	S	No	No
/v1/weatherapikey/1/2	Y	N	S	No	No
/v1/weatherapikey/1/2/	Y	N	Y	S	No
/v1/weatherapikey/1/2/3/	Y	N	Y	Y	Y
/v1/weatherapikey/1/a/2/3/	Y	N	S	No	No

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 qualsiasi percorso secondario, come /v1/weatherapikey/forecastrss, /v1/weatherapikey/region/CA e così via.

Puoi modificare questo valore predefinito 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 elementi dopo la barra /. Se apporti questa modifica, nella tabella precedente solo le prime due righe in "Consentito per /" conterranno "Y".

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

Modifica di 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 come richiesto.

   Puoi eliminare le risorse che hai aggiunto a un prodotto API. Questa operazione può essere utile 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 essere ancora utilizzate da altri prodotti.

5. Fai clic su Salva.

Con Apigee Edge per il cloud pubblico, Edge mantiene nella cache le seguenti entità per almeno 180 secondi dopo l'accesso alle entità.

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

Eliminazione di un prodotto API

Prima di poter eliminare un prodotto API, devi annullare la registrazione/annullamento dell'associazione di eventuali app per sviluppatori associate al prodotto. Per farlo, elimina le app o revoca le chiavi API dell'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 .
4. Fai clic su Elimina per confermare l'operazione di eliminazione.