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 tue API è tramite la registrazione delle applicazioni.

In qualità di provider API, puoi creare uno o più Prodotti API che includono le tue API nei livelli di servizio. I prodotti API ti 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 Interno . Per ulteriori 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 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. tutti o un sottoinsieme di prodotti API a cui fa riferimento quell'app.

Diagramma di uno sviluppatore con tre app.

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

Puoi avere un maggiore controllo sul processo di registrazione delle app registrando le tue app tramite l'interfaccia utente di Apigee o l'API Apigee. Ad esempio, potresti voler registrare app per i tuoi team di sviluppo interno 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 la UI e l'API.

Esplorazione della 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'interfaccia utente di Apigee:

La visualizzazione App ti consente di:

Registrazione di un'app

Un'app può essere registrata nei seguenti modi:

  • Da uno sviluppatore di app: uno sviluppatore può registrare l'app tramite il tuo portale, come descritto in Come funziona gli sviluppatori interagiscono con il tuo 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 quanto segue:

Per registrare un'app in Apigee:

  1. Accedi alla pagina App.
  2. Specifica i Dettagli dell'app, come descritto nella tabella seguente:
    Campo Descrizione Obbligatorio?
    Nome Il nome dell'app. Non puoi modificare il nome dopo aver creato l'app. Questo nome viene utilizzato nelle chiamate all'API Apigee. Obbligatorio
    Nome visualizzato Nome visualizzato dell'app nell'interfaccia utente 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 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 lo stato e la scadenza della chiave API, nonché i campi prodotti API associati. Nella sezione Credenziali, fai clic su e inserisci le seguenti informazioni:
    Campo Descrizione
    Scadenza Configura una durata o una data 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 Status 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'altra. Il numero massimo di che è possibile aggiungere è 18.
  5. Fai clic su Crea.

Se i prodotti API associati all'app richiedono l'approvazione manuale per le relative chiavi API, approvale come descritto in Approvare o revocare le 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 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, 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 nel 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 Importa secret e chiavi utente esistenti.

Visualizzazione di una chiave API e di un segreto

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 alla chiave API o al segreto 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, devi approvare manualmente la chiave.

È 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 riapproverare 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 operazioni:
    • Per approvare o revocare una chiave API per tutti i prodotti API associati a una chiave API, seleziona Approvata o Rivocata associata alla chiave API.
    • Per approvare o revocare una chiave API per uno specifico prodotto API, seleziona Approvato oppure Revocato nella colonna Stato per il prodotto API.
  5. Fai clic su Salva.

Gestione dei 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 operazioni:
    • 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 Credenziali 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'API prodotto, puoi rimuoverlo 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 di nuove credenziali

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 la rotazione quando scadono. Puoi anche generare una nuova chiave/segreto se la sicurezza della chiave/del segreto originale è compromessa. Se generi una nuova chiave, le eventuali chiavi API esistenti continueranno a esistere funzionino fino alla scadenza o alla 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 relativo stato.
  6. Facoltativamente, revoca qualsiasi altra chiave API, come obbligatorio.
  7. Fai clic su Salva.

Approvare o revocare 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 a Apigee. Quando approvi di nuovo un'app, tutte le chiavi API approvate e valide possono essere utilizzate per effettuare chiamate API.

Se l'app è registrata in altre organizzazioni, devi revocarla in ognuna di queste le tue organizzazioni. 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 app per approvare o revocare l'app, rispettivamente.
  5. Fai clic su Salva.

Eliminare un'app

Quando elimini un'app, tutte le chiavi client associate alle app non sono più valide. L'utilizzo di un a causa di una chiave non valida su una richiesta, la richiesta non riesce.

Se ritieni di voler reintegrare un'app sviluppatore in futuro, un'alternativa a l'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 delle app e gestione delle chiavi API utilizzando l'API

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

Vedi anche Importa i segreti e le chiavi dei consumatori esistenti.