In che modo gli utenti del portale interagiscono con il portale

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Il portale per gli sviluppatori consente agli utenti del portale di creare un account utente, accedere e gestire le app che utilizzeranno le tue API.

Le sezioni seguenti descrivono in che modo gli utenti del portale interagiscono con il portale.

Accedere al portale

Le seguenti sezioni descrivono come gli utenti del portale accedono al portale integrato utilizzando le proprie credenziali utente (provider di identità integrato) o utilizzando SAML (anteprima).

Se attivi sia il provider di identità integrato sia quello SAML, gli utenti del portale potranno scegliere il metodo di accesso che preferiscono.

Accesso al portale utilizzando le credenziali utente (provider di identità integrato)

Nota:la pagina di accesso non può essere modificata, se non per cambiare il logo dell'azienda come descritto in Configurare l'esperienza di creazione di account utente e di accesso.

Quando il provider di identità integrato è abilitato, gli utenti del portale possono accedere al portale integrato utilizzando le proprie credenziali utente (nome utente e password), come descritto nelle sezioni seguenti:

• Creare un account utente sul portale integrato
• Accedere al portale integrato
• Modificare la password

Creazione di un account utente sul portale integrato

Con il provider di identità integrato, prima che gli utenti del portale possano utilizzare le tue API, devono creare un account utente sul portale integrato.

Punto chiave:vedi anche Dove vengono memorizzati i dati dell'account sviluppatore di app.

Sebbene sia possibile creare manualmente account utente per conto degli utenti del portale utilizzando la UI di Apigee, come descritto in Registrazione degli sviluppatori di app, questa operazione non è consigliata per garantire che gli account utente sul portale integrato e i record degli sviluppatori su Apigee rimangano sincronizzati.

Gli utenti del portale creano un account sul portale integrato nel seguente modo:

1. Vai al portale.

2. Fai clic su Accedi.

   Viene visualizzata la pagina di accesso.

3. Fai clic su Crea account.

   Viene visualizzata la pagina Crea il tuo account.

   

   Nota:puoi aggiungere campi di registrazione personalizzati alla pagina di creazione dell'account, come descritto in Aggiungere campi di registrazione personalizzati alla pagina di creazione dell'account.

4. Compila il modulo.

   Devi inserire i valori per tutti i campi obbligatori. Le password devono essere costituite da almeno 8 caratteri e contenere almeno un numero, una lettera minuscola, una lettera maiuscola e un carattere speciale.

5. Leggi e accetta i termini.

6. Fai clic su Crea account.

   Nota:se viene effettuato un tentativo di creare un account con un ID email già registrato, viene visualizzato un messaggio che indica che l'account esiste già e l'utente del portale viene invitato ad accedere.

7. Compila il modulo CAPTCHA e fai clic su Verifica (se visualizzato).

   L'account utente viene creato e viene inviata un'email di conferma.

   Nota:puoi configurare l'email di conferma, come descritto in Configurazione delle notifiche via email. Apigee consiglia di configurare il server SMTP utilizzato per le notifiche email provenienti dal portale prima del lancio, come descritto in Configurazione del server SMTP.

8. Entro 10 minuti, fai clic sul link nell'email di conferma per completare la procedura di registrazione.

   Se non fai clic sul link entro 10 minuti, devi ripetere i passaggi di questa procedura per creare un account e ricevere nuovamente la richiesta.

9. Accedi al portale integrato (descritto di seguito).

Accedere al portale integrato

Con il provider di identità integrato, dopo la registrazione e l'approvazione, gli utenti del portale accedono utilizzando le proprie credenziali (nome utente e password).

Note:

• Dopo 24 ore di inattività, la sessione scadrà e l'utente del portale verrà disconnesso automaticamente e dovrà accedere di nuovo.
• Se hai configurato il portale integrato in modo che richieda l'attivazione manuale degli account utente, devi attivare manualmente gli account utente prima che gli utenti del portale possano accedere. Al momento, gli utenti del portale non ricevono alcuna indicazione che la loro registrazione deve essere attivata manualmente prima di poter accedere. Se configuri l'attivazione manuale, ti consigliamo di accelerare l'attivazione dei nuovi account utente.
• Per andare direttamente alla pagina di accesso, utilizza il seguente URL:
  https://portal-url/login

Gli utenti del portale accedono nel seguente modo:

1. Vai al portale.

2. Fai clic su Accedi. La pagina di accesso mostra:

   

3. Inserisci l'indirizzo email e la password.

4. Fai clic su Accedi.

Modifica della password

Con il provider di identità integrato, gli utenti del portale cambiano la password nel seguente modo:

1. Vai al portale.
2. Fai clic su Accedi.
3. Fai clic su Reimposta password.
4. Inserisci l'indirizzo email dell'account da reimpostare.

5. Fai clic su Invia link per la reimpostazione della password.

   Un link di reimpostazione della password viene inviato all'indirizzo email.

   Nota: per configurare il server SMTP, consulta Configurazione del server SMTP.

6. Fai clic sul link nell'email di conferma.

7. Inserisci la nuova password e confermala.

   Le password devono essere costituite da almeno 8 caratteri e contenere almeno un numero, una lettera minuscola, una lettera maiuscola e un carattere speciale.

8. Fai clic su Crea nuova password.

Accesso al portale tramite l'autenticazione SAML (anteprima)

Nota:questa è la versione di anteprima del provider di identità SAML.

Nota:la pagina di accesso non può essere modificata, se non per cambiare il logo dell'azienda come descritto in Configurazione dell'esperienza di creazione di account utente e di accesso.

Quando il provider di identità SAML è abilitato, gli utenti del portale accedono al portale integrato utilizzando l'autenticazione SAML, come segue:

1. Vai al portale.
2. Fai clic su Accedi.

3. Fai clic su Accedi con SAML.

   Viene visualizzato il provider SAML.

4. Se richiesto, inserisci le credenziali del tuo provider di identità SAML.

Nota: dopo 24 ore di inattività, la sessione scadrà e l'utente del portale verrà disconnesso automaticamente e dovrà accedere di nuovo.

Visualizzare la documentazione di riferimento dell'API

Gli utenti del portale possono visualizzare la documentazione di riferimento dell'API che hai pubblicato sul tuo portale nel seguente modo:

1. Vai al portale.

2. Fai clic su API nella barra di navigazione in alto. Viene visualizzata la pagina API. Ad esempio:
   
   

3. Se vuoi, filtra l'elenco delle API per categoria, titolo o descrizione utilizzando gli strumenti nel riquadro a sinistra.

4. Fai clic su una scheda API per visualizzare la documentazione di riferimento dell'API. Viene visualizzata la documentazione di riferimento dell'API.

Gli utenti del portale possono scoprire e provare le API o scaricare il documento utilizzato per il rendering della documentazione di riferimento delle API. Per saperne di più sul rendering della documentazione di riferimento dell'API, consulta la sezione Pubblicare le API.

Condividere la responsabilità di un'app utilizzando i team di sviluppatori (anteprima)

Nota:devi aver eseguito la registrazione alla release di anteprima della funzionalità Team.

I team di sviluppatori consentono agli utenti del portale di condividere la responsabilità di un'app con altri utenti del portale. Le sezioni seguenti descrivono come creare e gestire i team di sviluppatori.

Punto chiave:i team di sviluppatori vengono chiamati semplicemente "team" quando si naviga nel portale per sviluppatori.

Informazioni sui ruoli del team di sviluppatori

La seguente tabella riassume i ruoli che possono essere assegnati ai membri del team di sviluppo:

Nota:in qualità di membro del team di sviluppatori, puoi rimuoverti da qualsiasi team di sviluppatori indipendentemente dal tuo ruolo, a meno che tu non sia il proprietario del team di sviluppatori.

Ruolo	Descrizione
Amministratore app	Privilegi di sola lettura per i membri del team di sviluppo e i dettagli del team di sviluppo. Privilegi di lettura e scrittura per le app.
Proprietario	Privilegi di lettura e scrittura completi per i membri del team di sviluppo, i dettagli del team di sviluppo e le app.
Visualizzatore	Privilegi di sola lettura per i membri del team di sviluppo, i dettagli del team di sviluppo e le app.

Visualizzare la pagina Team

La pagina Team mostra i team di sviluppatori di cui fai parte.

Per accedere alla pagina Teams:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa dell'account utente nel portale.

Viene visualizzata la pagina Team, che ti consente di:

• Visualizza i team di sviluppatori di cui fai parte, inclusi il nome, il ruolo, l'elenco dei membri e la data di creazione del team.
• Aggiungere un team di sviluppatori
• Modifica l'appartenenza e i ruoli del team di sviluppatori, rimuoviti da un team di sviluppatori o elimina un team facendo clic sulla riga del team di sviluppatori.

Aggiungere team di sviluppatori

Nota:gli utenti del portale possono visualizzare i team di sviluppatori di cui fanno parte nella pagina Team. Per la release di anteprima, non vengono inviate notifiche quando un utente del portale viene aggiunto a un team di sviluppatori.

Per aggiungere un team di sviluppatori:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa dell'account utente nel portale.
3. Fai clic su + Nuovo team.
4. Inserisci un nome e una descrizione.

5. Per aggiungere un membro al team di sviluppatori, fai clic su + Aggiungi un altro membro, inserisci l'indirizzo email dell'utente del portale e seleziona un ruolo del team di sviluppatori.

   Ripeti l'operazione per aggiungere altri membri.

   Nota:

   • Vieni aggiunto automaticamente come proprietario del team di sviluppatori.
   • Il numero massimo di team di sviluppatori di cui un utente può essere membro è 16.

6. Per eliminare un membro dal team di sviluppatori, fai clic su accanto al membro del team di sviluppatori che vuoi eliminare.

7. Fai clic su Crea.

Modificare l'appartenenza e i ruoli del team di sviluppatori

Per modificare l'appartenenza e i ruoli del team di sviluppatori:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa dell'account utente nel portale.
3. Fai clic sulla riga del team di sviluppatori che vuoi modificare e di cui sei proprietario.

4. Esegui uno o più dei seguenti passaggi:

   • Modifica il nome, la descrizione e il contatto principale.
   • Aggiungere o rimuovere membri del team di sviluppo.
   • Aggiorna i ruoli dei membri del team di sviluppatori.
     Nota:

     • Un team di sviluppatori deve avere almeno un proprietario.
     • Il numero massimo di team di sviluppatori di cui un utente può essere membro è 16.

5. Fai clic su Salva.

Rimozione da un team di sviluppatori

Nota:in qualità di membro del team di sviluppatori, puoi rimuoverti da qualsiasi team di sviluppatori indipendentemente dal tuo ruolo nel team di sviluppatori, a meno che tu non sia il proprietario del team di sviluppatori.

Per rimuovere il tuo account da un team di sviluppatori:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa dell'account utente nel portale.
3. Fai clic sulla riga del team di sviluppatori da cui vuoi rimuoverti.
4. Fai clic su Abbandona il team.

Eliminazione di un team di sviluppatori

Nota:quando elimini un team di sviluppatori, vengono eliminate tutte le app di proprietà del team.

Per eliminare un team di sviluppatori:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa dell'account utente nel portale.
3. Fai clic sulla riga del team di sviluppatori che vuoi eliminare.
4. Fai clic su .
5. Fai clic su Conferma per confermare l'eliminazione.

Registrazione delle app

Registra le app per sviluppatori e le app del team di sviluppo, come descritto nelle sezioni seguenti.

Registrazione delle app per sviluppatori

Punto chiave: dopo che l'utente del portale registra un'app sviluppatore, le informazioni dell'account utente vengono sincronizzate e rese disponibili su Apigee nella pagina Sviluppatori. Consulta Dove vengono archiviati i dati dell'account sviluppatore di app.

Gli utenti del portale possono registrare le app per utilizzare le API che hai pubblicato nel seguente modo:

1. Nel portale, seleziona App dal menu a discesa dell'account utente.
2. Fai clic su + Nuova app per creare una nuova app.
3. Inserisci un nome e una descrizione per l'app nella finestra di dialogo Nuova app.

4. Nella sezione API, abilita una o più API.

   Le API nel catalogo sono classificate come API autenticate, che richiedono un URL di callback, o API pubbliche. Devi selezionare almeno un'API per creare un'app.

5. Se selezioni un'API nella sezione API autenticate, inserisci un URL di callback.

   Per saperne di più, consulta la sezione Informazioni sugli URL di callback.

6. Fai clic su Salva.

Registrazione delle app del team di sviluppatori

Nota:questo passaggio è applicabile solo se hai eseguito la registrazione alla release di anteprima della funzionalità dei team. Nell'anteprima, la proprietà dell'app non può essere trasferita dopo la creazione dell'app.

I membri del team di sviluppo possono registrare le app per un team di sviluppo per utilizzare le API che hai pubblicato, come descritto di seguito.

Nota: una nuova entità team di sviluppatori verrà aggiunta ad Apigee solo dopo che un membro avrà registrato un'app per il team. Consulta Dove vengono archiviate le informazioni del team di sviluppatori (anteprima).

Per scoprire di più su come:

• Gli utenti del portale aggiungono e gestiscono i team, come descritto in Condividere la responsabilità di un'app utilizzando i team di sviluppatori (anteprima).
• I fornitori di API visualizzano e gestiscono i team di sviluppatori, come descritto in Gestione dei team di sviluppatori (anteprima).

Per registrare le app del team di sviluppatori:

1. Seleziona Team dal menu a discesa dell'account utente.
2. Fai clic sulla riga del team di sviluppatori per cui vuoi registrare un'app.
3. Fai clic su + Nuova app per creare una nuova app.
4. Inserisci un nome e una descrizione per l'app nella finestra di dialogo Nuova app.

5. Seleziona il proprietario dell'app dall'elenco a discesa Proprietario.

   Per impostazione predefinita, il team di sviluppo è il proprietario dell'app. Se vuoi, seleziona un altro team di sviluppo o te stesso come proprietario dal menu a discesa.

   Nota: nella release di anteprima, la proprietà dell'app non può essere trasferita dopo la creazione dell'app.

6. Nella sezione Catalogo API, abilita una o più API.

   Le API nel catalogo sono classificate come API autenticate, che richiedono un URL di callback, o API pubbliche. Devi selezionare almeno un'API per creare un'app.

7. Se selezioni un'API nella sezione API autenticate, inserisci un URL di callback.

   Per saperne di più, consulta la sezione Informazioni sugli URL di callback.

8. Fai clic su Salva.

Gestione delle API in un'app

In qualità di produttore di API, pubblichi le API per consentire agli utenti del portale di utilizzare i tuoi prodotti API.

Gli utenti del portale gestiscono le API utilizzate dalle loro app. Le API vengono aggiunte alla pagina dei dettagli dell'app. Per alcune API, l'approvazione non è automatica. Lo stato In attesa di approvazione indica un'API per la quale è stato richiesto l'accesso, ma non ancora concesso.

Nota:le API non pubblicate non vengono visualizzate al momento; questo problema verrà risolto in una release futura.

Se l'utente del portale disattiva l'accesso a un'API privata o solo interna, l'API viene rimossa dall'app e deve essere riaggiunta manualmente dall'amministratore del portale, come descritto in Controllo dell'accesso alle API mediante la registrazione delle app.

Gli utenti del portale possono gestire le API in un'app dal tuo portale nel seguente modo:

1. Seleziona App dal menu a discesa dell'account utente.
2. Fai clic sull'app nell'elenco.
3. Nella sezione API, fai clic su Abilita o Disabilita accesso per aggiungere o rimuovere un'API dall'app.
4. Per un'API autenticata, aggiungi o modifica l'URL di callback, se necessario.
5. Fai clic su Salva.

Visualizzare la chiave API e il segreto per un'app

Gli utenti del portale possono gestire la chiave API per un'app dal portale nel seguente modo:

1. Seleziona App dal menu a discesa dell'account utente.
2. Fai clic sull'app nell'elenco.
3. Visualizza le chiavi API nella sezione Chiavi API.
4. Verifica che lo stato della chiave API sia Attiva. Se la tua chiave API richiede l'approvazione e non è ancora stata approvata, lo stato sarà In attesa di approvazione.
5. Fai clic su Mostra secret per visualizzare il secret.
6. Posiziona il cursore sulla chiave API o sul secret e fai clic su per copiarlo negli appunti.

Nota:se l'account utente o l'app sono stati disattivati/revocati, la chiave API non sarà valida finché l'account utente o l'app non verranno riattivati/riapprovati. Per saperne di più, vedi Attivare e disattivare uno sviluppatore e Approvare o revocare un'app.

Rotazione della chiave API per un'app

Un utente del portale può ruotare periodicamente la chiave API di un'app o in risposta a una potenziale perdita o compromissione. Quando un utente del portale ruota una chiave API, viene creata una nuova chiave API con gli stessi diritti API della chiave originale. La chiave API originale rimane attiva durante la transizione. Devi revocare la vecchia chiave API per impedire l'accettazione delle relative credenziali, come descritto in Revocare una chiave API per un'app.

Gli utenti del portale possono ruotare una chiave API per un'app dal portale nel seguente modo:

1. Seleziona App dal menu a discesa dell'account utente.
2. Fai clic sull'app nell'elenco.
3. Nella sezione Chiavi API, fai clic su Aggiungi chiave.
4. Fai clic su Conferma nella finestra di dialogo per confermare l'operazione.
5. (Facoltativo) Revoca la vecchia chiave API, come descritto di seguito.

Revoca di una chiave API per un'app

Quando un utente del portale ruota una chiave API, come descritto nella sezione precedente, la chiave API rimane attiva durante la transizione fuori uso. Devi revocare una chiave API per impedire l'accettazione delle relative credenziali.

Gli utenti del portale possono revocare una chiave API per un'app dal portale nel seguente modo:

1. Seleziona App dal menu a discesa dell'account utente.
2. Fai clic sul nome dell'app.
3. Nella sezione Chiavi API, fai clic su Revoca nella colonna Azioni associata alla chiave API che vuoi revocare.

4. Fai clic su Conferma per confermare l'operazione.

   Lo stato della chiave viene aggiornato a Revocata.

Modifica dei dettagli dell'app

Gli utenti del portale possono modificare i dettagli dell'app nel seguente modo:

1. Seleziona App dal menu a discesa dell'account utente.
2. Fai clic sull'app nell'elenco.
3. Modifica i campi Nome o Descrizione nella scheda Dettagli app.
4. Gestisci le API in un'app, se necessario.
5. Fai clic su Salva.

Eliminare un'app

Gli utenti del portale possono eliminare un'app dal portale nel seguente modo:

1. Seleziona App dal menu a discesa dell'account utente.
2. Fai clic sull'app nell'elenco.
3. Fai clic su ELIMINA.
4. Fai clic su Conferma per confermare l'operazione.

L'app viene eliminata e rimossa dall'elenco delle app.