Controllo dell'accesso alle API mediante la registrazione delle app

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

Questa sezione descrive come registrare le app e gestire le chiavi API.

Panoramica

Il modo principale per controllare chi può accedere alle tue API è attraverso la registrazione delle applicazioni.

In qualità di provider di API, puoi creare uno o più prodotti API che raggruppano le tue API nei livelli di servizio. I prodotti API consentono di limitare i livelli di traffico e accesso a livelli molto granulari. Quando crei un prodotto API, puoi impostare il livello di accesso su Pubblico, Privato o Solo interno. Per maggiori informazioni, vedi Livello di accesso.

Quando registra un'app, lo sviluppatore seleziona i prodotti API da utilizzare e Apigee fornisce un'unica chiave API che lo sviluppatore utilizza per accedere ai prodotti API. Lo sviluppatore dell'app passa la chiave API in ogni chiamata ai proxy API contenuti nei prodotti API. Puoi revocare in qualsiasi momento la chiave API di un'app, impedendo a uno sviluppatore di app di accedere a tutti o a un sottoinsieme di prodotti API a cui fa riferimento l'app.

Diagramma di uno sviluppatore con tre app.

In genere, gli sviluppatori di app si registrano per usare i tuoi prodotti API tramite il tuo portale per gli sviluppatori. I passaggi per creare il portale e pubblicare i prodotti API sono descritti in Creare il portale.

Puoi avere un maggiore controllo sul processo di registrazione delle app registrandole utilizzando invece l'UI Apigee o l'API Apigee. Ad esempio, potresti registrare le app per i tuoi team di sviluppo interni o per uno sviluppatore che non può accedere al tuo portale.

Le seguenti sezioni descrivono come registrare le app e gestire le chiavi API utilizzando l'interfaccia utente e l'API.

Esplorazione della pagina App

Per registrare app e gestire le chiavi API nella UI di Apigee, utilizza la visualizzazione App.

Per accedere alla visualizzazione App utilizzando la UI di Apigee:

La visualizzazione App ti consente di:

Registrazione di un'app

Un'app può essere registrata nei seguenti modi:

  • Uno sviluppatore di app:uno sviluppatore di app può registrare l'app tramite il tuo portale, come descritto nella sezione In che modo gli sviluppatori di app interagiscono con il portale.
  • Da un amministratore:puoi registrare un'app in Apigee, come descritto di seguito. Spetta a te stabilire come fornire la chiave allo sviluppatore dell'app.

Le app registrate vengono aggiunte a quanto segue:

Per registrare un'app in Apigee:

  1. Accedi alla pagina App.
  2. Specifica i Dettagli sull'app, come descritto nella tabella seguente:
    Campo Descrizione Obbligatorio?
    Nome Nome dell'app. Non puoi modificarlo dopo aver creato l'app. Questo nome è utilizzato nelle chiamate API Apigee. Obbligatorio
    Nome visualizzato Nome visualizzato per l'app presente nella UI di Apigee e nel portale per gli sviluppatori. Facoltativo
    Sviluppatore

    Seleziona un nome sviluppatore dal menu a discesa.

    Nota:per motivi legati alle prestazioni, non tutti gli sviluppatori vengono visualizzati nel menu a discesa. Inizia a digitare il nome o l'indirizzo email dello sviluppatore nella casella di ricerca e i valori del menu a discesa vengono perfezionati automaticamente per corrispondere al testo che stai digitando. Vedi anche Registrare gli sviluppatori di app.

    		 Obbligatorio
    URL di callback In genere specifica l'URL di un'app designata per ricevere un codice di autorizzazione per conto dell'app client. Questo valore non è richiesto per tutti i prodotti API. Facoltativo
    Note Note descrittive per l'app. Facoltativo
  3. Specifica le credenziali, inclusi la scadenza e lo stato delle chiavi API e i prodotti API associati. Nella sezione Credenziali, fai clic su e inserisci le informazioni seguenti:
    Campo Descrizione
    Scadenza Configura una durata o una data di scadenza oppure imposta la chiave API in modo che non scada mai, quindi fai clic su OK.
    Prodotti Associa uno o più prodotti API alla chiave API:
    1. Fai clic su Aggiungi prodotto.
    2. Seleziona uno o più prodotti API dall'elenco.
    3. Fai clic su Aggiungi.
    4. Imposta lo Stato su Approvato o Revocato per ogni prodotto API.
    5. Ripeti i passaggi per aggiungere altri prodotti API.
  4. Specifica gli attributi personalizzati:
    1. Nella sezione Attributi personalizzati, fai clic su .
    2. Inserisci il nome e il valore.
    3. Fai clic su Aggiungi o Aggiungi e avvia un altro. Il numero massimo di attributi personalizzati che puoi aggiungere è 18.
  5. Fai clic su Crea.

Se i prodotti API associati all'app hanno richiesto l'approvazione manuale per le relative chiavi API, approvale, come descritto in Approvazione o revoca delle chiavi API.

Visualizzazione di app registrate per uno sviluppatore

Per visualizzare le app registrate per uno sviluppatore specifico, utilizza uno dei seguenti metodi:

Visualizzazione e modifica di un'app

Per visualizzare e modificare un'app:

  1. Accedi alla pagina App.
  2. Fai clic in un punto qualsiasi della riga dell'app che vuoi visualizzare e modificare. Apigee visualizza i dettagli dell'app.
  3. Per modificare un'app, fai clic su Modifica.
  4. Esegui una o più delle seguenti attività:
    • Modifica i dettagli dell'app, inclusi il nome, l'URL di callback o le note.
    • Gestisci le credenziali.
    • Aggiungi o elimina attributi personalizzati. Il numero massimo di attributi personalizzati che puoi aggiungere è 18.
    • Approvare o revocare l'app.
  5. Fai clic su Salva.

Gestione delle credenziali

Quando modifichi un'app, puoi gestirne le credenziali nella sezione Credenziali, come mostrato nella figura seguente:

Diagramma del riquadro Credenziali.

Come evidenziato nella figura precedente, nella sezione Credenziali puoi eseguire le seguenti attività utilizzando l'interfaccia utente:

Per utilizzare l'API per gestire le credenziali, consulta Importare i secret e le chiavi consumer esistenti.

Visualizzazione di un secret e di una chiave API

Per visualizzare una chiave API e un secret:

  1. Accedi alla pagina App.
  2. Fai clic sulla riga dell'app per cui vuoi visualizzare il secret e la chiave API.
  3. Nella sezione Credenziali, fai clic su Mostra associato al secret o alla chiave API che vuoi visualizzare.

Approvazione o revoca di una chiave API

Le chiamate API ai proxy API in genere richiedono una chiave API. Apigee consente le chiamate solo se la chiave API è approvata, valida e soddisfa le condizioni definite dal prodotto API contenente l'API.

Puoi configurare un prodotto API per l'approvazione automatica delle chiavi API, come descritto in Gestione dei prodotti API. Tuttavia, se il prodotto API richiede l'approvazione manuale delle chiavi API, dovrai approvare manualmente le chiavi.

È possibile revocare una chiave API per un prodotto API o per un singolo prodotto. In questo caso, la chiave API e il secret non sono validi e non possono essere utilizzati per accedere alle API nei prodotti API associati. Puoi riapprovare una chiave API in qualsiasi momento.

Per approvare o revocare una chiave API:

  1. Accedi alla pagina App.
  2. Fai clic sulla riga dell'app che vuoi visualizzare e modificare.
  3. Fai clic su Modifica.
  4. Esegui una delle seguenti attività:
    • Per approvare o revocare una chiave API per tutti i prodotti API associati a una chiave API, seleziona Approvato o Revocato associato alla chiave API.
    • Per approvare o revocare una chiave API per uno specifico prodotto API, seleziona Approvato o Revocato nella colonna Stato del prodotto API.
  5. Fai clic su Salva.

Gestione di prodotti API in un'app

Gestisci i prodotti API nella tua app svolgendo le seguenti attività:

Aggiunta di un prodotto API a un'app

Per aggiungere un prodotto API a un'app:

  1. Accedi alla pagina App.
  2. Fai clic sulla riga dell'app che vuoi visualizzare e modificare.
  3. Fai clic su Modifica.
  4. Esegui una delle seguenti attività:
    • Per aggiungere un prodotto API a una nuova chiave API, fai clic su per generare una nuova credenziale, seleziona una scadenza e aggiungi il prodotto API alla chiave API.
    • Per aggiungere un prodotto API a una chiave API esistente, nella sezione Credenziale, fai clic su Aggiungi prodotto e seleziona il prodotto API dall'elenco a discesa.
  5. Fai clic su Salva.

Rimozione di un prodotto API da un'app

Se vuoi mantenere attiva una chiave API, ma non consentirne l'utilizzo da parte di un prodotto API, puoi rimuoverla dalla credenziale associata.

  1. Accedi alla pagina App.
  2. Fai clic sulla riga dell'app che vuoi visualizzare e modificare.
  3. Fai clic su Modifica.
  4. Fai clic su accanto al prodotto API.
  5. Fai clic su Salva.

Puoi aggiungere nuovamente un prodotto rimosso.

Generazione delle nuove credenziali in corso...

Puoi generare nuove credenziali per un'app. Ad esempio, se utilizzi rotazione della chiave API, puoi generare nuove chiavi la cui scadenza si sovrappone a chiavi che non saranno più rotazione quando scadono. Potresti anche generare una nuova chiave/segreta se la sicurezza della chiave/segreta originale è compromessa. Se generi una nuova chiave, le chiavi API esistenti continueranno a funzionare fino alla loro scadenza o fino alla loro revoca esplicita.

Per generare una nuova chiave API:

  1. Accedi alla pagina App.
  2. Fai clic sulla riga dell'app che vuoi visualizzare e modificare.
  3. Fai clic su Modifica.
  4. Nella sezione Credenziali, fai clic su .
  5. Specifica la scadenza, aggiungi i prodotti API e imposta il loro stato.
  6. Facoltativamente, revoke qualsiasi altra chiave API, come richiesto.
  7. Fai clic su Salva.

Approvazione o revoca di un'app

Approva o revoca un'app, come descritto di seguito. Quando revochi un'app, tutte le chiavi API approvate non possono più essere utilizzate nelle chiamate API ad Apigee. Quando riapprova un'app, tutte le chiavi API valide e approvate possono essere utilizzate per effettuare chiamate API.

Se l'app è registrata in altre organizzazioni, devi revocarla in ognuna di queste. Potrebbero essere necessari alcuni minuti prima che le modifiche vengano riconosciute da tutti i processori di messaggi.

Per approvare o revocare un'app:

  1. Accedi alla pagina App.
  2. Fai clic sulla riga dell'app che vuoi visualizzare e modificare.
  3. Fai clic su Modifica.
  4. Seleziona Approva o Revoca nel campo Stato applicazione per approvare o revocare, rispettivamente, l'app.
  5. Fai clic su Salva.

Eliminazione di un'app

Quando elimini un'app, tutte le chiavi client associate alle app non sono più valide. L'utilizzo di una chiave non valida in una richiesta ne impedisce l'esito.

Se ritieni di voler reintegrare un'app sviluppatore in futuro, un'alternativa all'eliminazione è la revoca di un'app.

Per eliminare un'app:

  1. Accedi alla pagina App.
  2. Posiziona il cursore nella riga dell'app che vuoi eliminare.
  3. Fai clic su nella colonna delle azioni.

Registrazione di app e gestione delle chiavi API mediante l'API

Per registrare e gestire le app utilizzando l'API Apigee, usa le seguenti API:

Vedi anche Importare secret e chiavi utente esistenti.