Registra le app e gestisci le chiavi API

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

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 API.

In qualità di provider di API, puoi creare uno o più prodotti API per raggruppare le tue API, come spiegato nella sezione Gestire i prodotti basati su API. Quando registra un'app, lo sviluppatore dell'app seleziona i prodotti API da utilizzare ed Edge fornisce una singola chiave API che lo sviluppatore può utilizzare 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 la chiave API di un'app in qualsiasi momento, impedendo allo 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 prodotti API tramite il portale per gli sviluppatori. I passaggi per creare il portale e pubblicare i prodotti basati su API sono descritti in Creare il portale.

In alternativa, in qualità di provider di API, potresti volere un maggiore controllo sul processo di registrazione delle app e scegliere di registrare le app 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 accedere al tuo portale.

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

Esplorare la pagina delle app

Accedi alla pagina Applicazioni ed esplorala, 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 Come gli sviluppatori di app interagiscono con il tuo portale.
• Puoi registrare un'app in Edge, come descritto di seguito. Spetta a te stabilire come fornire la chiave allo sviluppatore dell'app.

Le app registrate vengono aggiunte a:

• Elenco di app registrate in Edge. Vedi Visualizzare e modificare i dettagli sviluppatore.
• Pagina delle 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 dell'app:

   Campo	Descrizione	Campo 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 presente nell'interfaccia utente di gestione perimetrale e nel portale per gli sviluppatori.	No
   Società/sviluppatore	Nota: Apigee hybrid non supporta le app aziendali; questo campo non si applica. Seleziona Società o Sviluppatore e scegli il nome di una società o di uno sviluppatore dal menu a discesa. Nota: per motivi legati alle prestazioni, non tutte le aziende o gli sviluppatori vengono visualizzati nel menu a discesa. Inizia a digitare il nome dell'azienda o dello 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 basati su 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 data o una durata 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: Fai clic su Aggiungi prodotto. Seleziona uno o più prodotti API dall'elenco. Fai clic su Aggiungi. Imposta lo 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 crea un altro.
      Il numero massimo di attributi personalizzati che puoi aggiungere è 18.
6. Fai clic su Crea.

Se i prodotti API che hai associato all'app hanno richiesto 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, utilizza uno dei seguenti metodi:

• Visualizza tutte le app registrate, seleziona Sviluppatore nel menu a discesa Cerca 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, tra cui nome, URL di callback o 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 illustrato nella figura seguente:

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

• Visualizzare una chiave API e un secret
• Approvare o revocare una chiave API per tutti i prodotti API associati o per un singolo prodotto API.
• Gestire i prodotti basati su API in un'app
• Genera nuove credenziali

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

• Gestione delle chiavi utente per le app
• Importare le chiavi e i secret utente 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 nella riga dell'app di cui vuoi visualizzare la chiave API e il secret.
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 di solito richiedono una chiave API. Edge consente le chiamate solo se la chiave API è approvata, valida e soddisfa le condizioni definite dal prodotto API che contiene l'API.

Puoi configurare un prodotto API per l'approvazione automatica delle chiavi API, come descritto nell'articolo Gestire i prodotti basati su 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 i prodotti 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 tale chiave, seleziona Approvato o Revocato associato 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 di prodotti basati su 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 attività:
   • Per aggiungere un prodotto API a una nuova chiave API, fai clic su per generare una nuova credenziale, seleziona un'esperienza 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.

Rimuovere un prodotto API da un'app

Se vuoi mantenere attiva una chiave API ma non vuoi che venga utilizzata da 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 la rotazione delle chiavi API, puoi generare nuove chiavi la cui scadenza si sovrappone a quelle che non saranno più in rotazione al momento della scadenza. Potresti anche generare una nuova chiave/segreta se la sicurezza di quella originale è compromessa. Se generi una nuova chiave, le eventuali 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 loro 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 chiavi API approvate non possono più essere utilizzate nelle chiamate API a Edge. 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 organizzazione. Potrebbero essere necessari alcuni minuti prima che le modifiche vengano riconosciute da tutti gli elaboratori dei 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 su una richiesta determina la mancata riuscita della richiesta.

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 Azioni.

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

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

Per registrare e gestire le app utilizzando l'API, consulta l'articolo Registrazione delle app degli sviluppatori. Vedi anche le seguenti sezioni della documentazione di riferimento dell'API:

• App
• App: Società
• App: sviluppatore
• Chiavi dell'app aziendale
• Chiavi dell'app per sviluppatori

Vedi anche Importare chiavi e secret utente esistenti.