Controllo dell'accesso alle API mediante la registrazione delle app

Questa pagina si applica ad Apigee e Apigee hybrid.

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 API è tramite la registrazione dell'applicazione.

In qualità di provider di API, puoi creare uno o più prodotti API che raggruppano le tue API in livelli di servizio. I prodotti basati su API consentono di limitare il traffico e i livelli di 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, consulta Livello di accesso.

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

Diagramma di uno sviluppatore con tre app.

In genere, gli sviluppatori di app si registrano per utilizzare i tuoi prodotti basati su API attraverso il tuo portale per 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'interfaccia utente Apigee o l'API Apigee. Ad esempio, potresti voler 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.

Esplorare la pagina App

Per registrare le app e gestire le chiavi API nell'interfaccia utente di Apigee, utilizza la visualizzazione App.

Per accedere alla visualizzazione App utilizzando l'UI di Apigee:

La visualizzazione App ti consente di:

Registrazione di un'app

Un'app può essere registrata nei seguenti modi:

  • Da parte di uno sviluppatore di app: uno sviluppatore di app può registrare l'app tramite il tuo portale, come descritto nella sezione Modalità di interazione degli sviluppatori di app con il portale.
  • Da parte di 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:

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 modificare il nome dopo aver creato l'app. Questo nome viene utilizzato nelle chiamate dell'API Apigee. Obbligatorio
    Nome visualizzato Nome visualizzato per l'app che compare nell'UI di Apigee e nel portale per gli sviluppatori. Facoltativo
    Sviluppatore

    Seleziona il nome di uno 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 dei menu a discesa vengono perfezionati automaticamente in base 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 è obbligatorio per tutti i prodotti API. Facoltativo
    Note Note descrittive per l'app. Facoltativo
  3. Specifica le Credenziali, inclusi la scadenza e lo stato della chiave API e i prodotti API associati. Nella sezione Credenziali, fai clic su e inserisci le seguenti informazioni:
    Campo Descrizione
    Scadenza Configura una data o una durata di scadenza oppure imposta la chiave API in modo che non scada mai e 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 avviane un altro. Il numero massimo di attributi personalizzati che puoi aggiungere è 18.
  5. Fai clic su Crea.

Se i prodotti API che hai associato all'app richiedono l'approvazione manuale per le relative chiavi API, approvali come descritto in Approvazione o revoca delle chiavi API.

Visualizzazione delle app registrate per uno sviluppatore

Per visualizzare le app registrate per uno sviluppatore specifico, usa 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 mostra 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, tra cui nome, URL per il callback o note.
    • Gestisci le credenziali.
    • Aggiungi o elimina gli 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 la UI:

Per utilizzare l'API per gestire le credenziali, vedi Importare chiavi e secret utente esistenti.

Visualizzazione di una chiave API e di un secret

Per visualizzare una chiave API e un secret:

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

Approvazione o revoca di una chiave API

Le chiamate API ai proxy API richiedono in genere 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 Gestire i prodotti API. Tuttavia, se il prodotto API richiede l'approvazione manuale delle chiavi API, devi approvare manualmente la chiave.

Puoi revocare una chiave API per tutti o per un singolo prodotto API. 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 Approvata o Revocata associata alla chiave API.
    • Per approvare o revocare una chiave API per un prodotto API specifico, seleziona Approvato o Revocato nella colonna Stato del prodotto API.
  5. Fai clic su Salva.

Gestione dei prodotti basati su 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.

Rimuovere 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 sulla accanto al prodotto API.
  5. Fai clic su Salva.

Puoi aggiungere di nuovo un prodotto rimosso.

Generazione di 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 quelle che non saranno ruotate alla scadenza. Potresti anche generare una nuova chiave o un nuovo secret se la sicurezza della chiave o del secret originale è compromessa. Se generi una nuova chiave, le eventuali chiavi API esistenti continueranno a funzionare fino a quando non scadono o non le revochi esplicitamente.

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 impostane lo stato.
  6. Facoltativamente, revoke qualsiasi altra chiave API, in base alle esigenze.
  7. Fai clic su Salva.

Approvazione o revoca di un'app

Approvare o revocare un'app, come descritto di seguito. Quando revochi un'app, le eventuali chiavi API approvate non possono più essere utilizzate nelle chiamate API ad Apigee. Quando riapprovi 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 ciascuna di queste organizzazioni. Potrebbero essere necessari alcuni minuti prima che le modifiche vengano riconosciute da tutti gli elaboratori dei messaggi.

Per approvare o revocare un'app, gli utenti devono:

  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 su una richiesta fa sì che quest'ultima non vada a buon fine.

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

Per eliminare un'app, gli utenti devono:

  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 delle app e gestione delle chiavi API mediante l'API

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

Vedi anche Importare chiavi e segreti utente esistenti.