Informazioni sul servizio Gestione API

3 minuti

Gestione API fornisce le funzionalità fondamentali per assicurare un programma API di successo attraverso il coinvolgimento degli sviluppatori, informazioni aziendali approfondite, strumenti di analisi, sicurezza e protezione. Ogni API è costituita da una o più operazioni e può essere aggiunta a uno o più prodotti. Per usare un'API, gli sviluppatori sottoscrivono un prodotto che contiene tale API, quindi chiamano l'operazione dell'API, in base ai criteri di utilizzo eventualmente applicabili.

Componenti di Gestione API

Gestione API di Azure comprende un gateway API, un piano di gestione e un portale per sviluppatori . Questi componenti sono ospitati in Azure e completamente gestiti per impostazione predefinita. Gestione API è disponibile in vari livelli che differiscono in termini di capacità e funzionalità.

Il gateway API è l'endpoint che:
- Accetta chiamate API e le instrada a back-end appropriati
- Verifica le chiavi API e altre credenziali presentate con le richieste
- Applica le quote di utilizzo e i limiti di frequenza
- Trasforma le richieste e le risposte specificate nelle istruzioni dei criteri
- Memorizza nella cache le risposte per migliorare la latenza della risposta e ridurre al minimo il carico nei servizi back-end
- Genera log, metriche e tracce per monitoraggio, creazione di report e risoluzione dei problemi
Il piano di gestione è l'interfaccia amministrativa in cui si configura il programma API. Usarlo per:
- Effettuare il provisioning e configurare le impostazioni del servizio Gestione API
- Definire o importare lo schema API
- Creare pacchetti di API nei prodotti
- Configurare criteri, ad esempio quote o trasformazioni per le API
- Ottenere informazioni dall'analisi
- Gestisci utenti
Il portale per sviluppatori è un sito Web generato automaticamente e completamente personalizzabile con la documentazione delle API. Usando il portale per sviluppatori, gli sviluppatori possono:
- Leggere la documentazione relativa alle API
- Chiamare un'API tramite la console interattiva
- Creare un account e sottoscrivere per ottenere le chiavi API
- Accedere all'analisi di utilizzo personalizzata
- Scaricare le definizioni api
- Gestire le chiavi API

Prodotti

I prodotti rappresentano il modo in cui le API sono presentate agli sviluppatori. I prodotti in Gestione API hanno una o più API e sono configurati con un titolo, una descrizione e le condizioni per l'utilizzo. I prodotti possono essere aperti o protetti. I prodotti protetti devono essere sottoscritti per poter essere usati, mentre i prodotti aperti possono essere usati senza una sottoscrizione. L'approvazione della sottoscrizione è configurata a livello di prodotto e può richiedere l'approvazione dell'amministratore o essere approvata automaticamente.

Gruppi

I gruppi vengono usati per gestire la visibilità dei prodotti per gli sviluppatori. Gestione API include i gruppi di sistema non modificabili seguenti:

Gli amministratori gestiscono le istanze del servizio Gestione API e creano le API, le operazioni e i prodotti usati dagli sviluppatori. Gli amministratori delle sottoscrizioni di Azure appartengono a questo gruppo.
Sviluppatori: utenti autenticati del portale per sviluppatori che creano applicazioni usando le API. Agli sviluppatori viene concesso di accedere al portale per sviluppatori e di creare applicazioni che chiamano le operazioni di un'API.
Guest: utenti del portale per sviluppatori non autenticati. È possibile concedere loro determinati accessi di sola lettura, ad esempio la possibilità di visualizzare le API ma non di chiamarle.

Oltre a questi gruppi di sistema, gli amministratori possono creare gruppi personalizzati o usare i gruppi esterni nei tenant di Microsoft Entra associati.

Sviluppatori

Gli sviluppatori rappresentano gli account utente in un'istanza del servizio Gestione API. Gli sviluppatori possono essere creati o invitati a partecipare dagli amministratori oppure possono iscriversi dal portale per sviluppatori. Ogni sviluppatore è membro di uno o più gruppi e può sottoscrivere i prodotti che concedono la visibilità a tali gruppi.

Criteri

I criteri sono una raccolta di istruzioni che vengono eseguite in modo sequenziale sulla richiesta o la risposta di un'API. Le istruzioni più comuni includono la conversione del formato da XML a JSON e la limitazione della frequenza delle chiamate per limitare la quantità di chiamate in arrivo da uno sviluppatore. Sono disponibili molti altri criteri.

Le espressioni di criteri possono essere usate come valori di attributo o valori di testo in uno qualsiasi dei criteri di Gestione API, salvo diversamente specificato dai criteri. Alcuni criteri quali Flusso di controllo e Imposta variabile sono basati su espressioni di criteri.