Registra le app e gestisci le chiavi API

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

Registra le app e gestisci le chiavi API, come descritto nelle sezioni seguenti.

Introduzione

La registrazione delle app fornisce il meccanismo principale per controllare chi può accedere alle tue API.

In qualità di provider di API, crei uno o più prodotti API per raggruppare le tue API, come spiegato in Gestire i prodotti API. Quando registra un'app, lo sviluppatore seleziona i prodotti API da utilizzare e Edge fornisce una singola chiave API che lo sviluppatore può utilizzare 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 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 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 Creare il portale.

In alternativa, in qualità di fornitore di API, potresti voler avere un maggiore controllo sulla procedura di registrazione delle app e scegliere di registrarle in Edge, come descritto nelle sezioni seguenti. Ad esempio, potresti voler registrare app per i tuoi team di sviluppo interni o per conto di uno sviluppatore senza accesso 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

Accedi ed esplora la pagina App, come descritto di seguito.

Registrazione di un'app

Un'app può essere registrata utilizzando uno dei seguenti metodi:

• Uno sviluppatore di app può registrare l'app tramite il tuo portale, come descritto in In che modo gli sviluppatori di app interagiscono con il tuo portale.
• Puoi registrare un'app in Edge, come descritto di seguito. Spetta a te decidere come fornire la chiave allo sviluppatore di app.

Le app registrate vengono aggiunte a:

• Elenco di app registrate in Edge. Consulta Visualizzare e modificare i dettagli dello sviluppatore.
• Pagina App nel portale per gli sviluppatori.

Per registrare un'app in Edge:

1. Accedi alla pagina App.
2. Fai clic su + App.
3. Specifica i Dettagli app:

   Campo	Descrizione	Obbligatorio?
   Nome	Nome dell'app. Non puoi modificare il nome dopo aver creato l'app. Questo nome viene utilizzato nelle chiamate all'API di gestione.	Sì
   Nome visualizzato	Nome visualizzato dell'app visualizzato nell'interfaccia utente di gestione di Edge e nel portale per gli sviluppatori.	No
   Società/sviluppatore	Nota: Apigee Hybrid non supporta le app aziendali; questo campo non è applicabile. Seleziona Azienda o Sviluppatore e seleziona il nome di un'azienda o di uno sviluppatore dal menu a discesa. Nota:per motivi di rendimento, non tutte le aziende o gli sviluppatori vengono visualizzati nel menu a discesa. Inizia a digitare il nome dell'azienda, lo sviluppatore o l'indirizzo email nella casella di ricerca. Vedi anche Registrare gli sviluppatori di app.	Sì
   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.	No
   Note	Note descrittive per l'app.	No

4. 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 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: Fai clic su Aggiungi prodotto. Seleziona uno o più prodotti API dall'elenco. Fai clic su Aggiungi. Imposta Stato su Approvato o Revocato per ogni prodotto API. Ripeti i passaggi per aggiungere altri prodotti API.

5. 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 attributi personalizzati che puoi aggiungere è 18.
6. Fai clic su Crea.

Se i prodotti API associati all'app richiedono l'approvazione manuale delle relative chiavi API, approvale come descritto in Approvare o revocare le chiavi API.

Visualizzare le app registrate per uno sviluppatore

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

• Visualizza tutte le app registrate, seleziona Sviluppatore nel menu a discesa Ricerca e inserisci il nome dello sviluppatore nel campo di ricerca.
• Visualizza tutti gli sviluppatori di app registrati e fai clic sulla riga associata allo sviluppatore.

Visualizzazione e modifica di un'app

Per visualizzare e modificare un'app:

1. Accedi alla pagina App.
2. Fai clic sulla riga dell'app che vuoi visualizzare e modificare.
   Vengono visualizzati 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 gli attributi personalizzati.
     Il numero massimo di attributi personalizzati che puoi aggiungere è 18.
   • Approva o revoca l'app.
5. Fai clic su Salva.

Gestione delle credenziali

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

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

• Visualizzare una chiave e un segreto API
• Approva o revoca una chiave API per tutti i prodotti API associati o per un singolo prodotto API.
• Gestire i prodotti API in un'app
• Genera nuove credenziali

Per utilizzare l'API per gestire le credenziali, consulta le sezioni seguenti:

• Gestire le chiavi dei consumatori per le app
• Importare secret e chiavi utente esistenti

Visualizzazione di una chiave API e di un segreto

Per visualizzare una chiave API e un segreto:

1. Accedi alla pagina App.
2. Fai clic sulla riga dell'app di cui vuoi visualizzare la chiave API e il secret.
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. Edge 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 segreto 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 un prodotto API specifico, seleziona Approvata o Rivocata nella colonna Stato del 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à:

• Aggiungere un prodotto API a un'app
• Rimuovere un prodotto API da un'app

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 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 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 quella delle chiavi che non saranno più in rotazione al termine della loro scadenza. Puoi anche generare una nuova chiave/segreto se la sicurezza della chiave/del segreto originale è compromessa. Se generi una nuova chiave, le chiavi API esistenti continueranno a funzionare 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. Se vuoi, revoca una delle altre chiavi API, come richiesto.
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 Edge. 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 ciascuna di esse. Potrebbero essere necessari alcuni minuti prima che le modifiche vengano riconosciute da tutti gli elaboratori 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 diventano non valide. L'utilizzo di una chiave non valida in una richiesta ne causa il fallimento.

Se ritieni di voler reintegrare un'app per sviluppatori 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.

Nota: con Apigee Edge per il cloud pubblico, l'eliminazione dell'app per sviluppatori e degli elementi associati avviene in modo asincrono. L'app sviluppatore viene eliminata immediatamente, ma l'eliminazione automatica delle risorse associate, come le chiavi dell'app o i token di accesso, può richiedere da alcuni secondi a qualche minuto.

Registrazione delle app e gestione delle chiavi API utilizzando l'API

Per registrare e gestire le app che utilizzano l'API, consulta la sezione Registrazione delle app per sviluppatori. Consulta anche le seguenti sezioni nella documentazione di riferimento dell'API:

• App
• App: azienda
• App: sviluppatore
• Company App Keys
• Chiavi app per sviluppatori

Consulta anche Importare secret e chiavi utente esistenti.