In che modo gli utenti del portale interagiscono con il tuo portale

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

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

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

Accesso al portale in corso...

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

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 aziendale come descritto in Configurare l'esperienza di creazione e accesso degli account utente.

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
• Cambiare 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 nel portale integrato.

Punto chiave:consulta anche la sezione Dove vengono archiviati i dati dell'account dello sviluppatore di app.

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

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

1. Vai al portale.

2. Fai clic su Sign In (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 in tutti i campi obbligatori. Le password devono essere costituite da almeno 8 caratteri e contenere almeno uno dei seguenti elementi: numero, lettera minuscola, lettera maiuscola e 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 che è già stato registrato, viene visualizzato un messaggio che indica che l'account esiste già e l'utente del portale sarà invitato ad accedere.
   1. 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 Configurare le notifiche via email. Apigee consiglia di configurare il server SMTP utilizzato per le notifiche email provenienti dal portale prima del lancio, come descritto in Configurare il server SMTP.

7. Entro 10 minuti, fai clic sul link nell'email di conferma per completare il processo di registrazione.

   Se non si fa clic sul collegamento entro 10 minuti, è necessario ripetere i passaggi di questa procedura per creare un account e visualizzare di nuovo la richiesta.

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

Accesso al portale integrato

Con il provider di identità integrato, dopo che gli utenti del portale si sono registrati sul portale integrato e vengono approvati, 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 da richiedere l'attivazione manuale degli account utente, devi attivare manualmente gli account utente prima che gli utenti del portale possano accedere. Al momento, agli utenti del portale non viene fornita alcuna indicazione sul fatto che la loro registrazione deve essere attivata manualmente prima di poter accedere. Se configuri l'attivazione manuale, è consigliabile 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 come segue:

1. Vai al portale.
2. Fai clic su Sign In (Accedi).
   Viene visualizzata la pagina di accesso:
   
3. Inserisci l'indirizzo email e la password.
4. Fai clic su Sign In (Accedi).

Modifica della password

Con il provider di identità integrato, gli utenti del portale cambiano la password come segue:

1. Vai al portale.
2. Fai clic su Sign In (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.

   Viene inviato un link per la reimpostazione della password all'indirizzo e-mail.

   Nota: per configurare il server SMTP, vedi Configurare il 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 uno dei seguenti elementi: numero, lettera minuscola, lettera maiuscola e carattere speciale.

8. Fai clic su Crea nuova password.

Accesso al portale tramite l'autenticazione SAML (beta)

Nota: questa è la release beta del provider di identità SAML.

Nota: la pagina di accesso può essere modificata solo cambiando il logo aziendale come descritto in Configurare l'esperienza di creazione e accesso degli account utente.

Quando il provider di identità SAML è attivato, gli utenti del portale accedono al portale integrato utilizzando l'autenticazione SAML, nel modo seguente:

1. Vai al portale.
2. Fai clic su Sign In (Accedi).

3. Fai clic su login with SAML (Accedi con SAML).

   Verrai reindirizzato al provider SAML.

4. Se richiesto, inserisci le credenziali per il 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.

Visualizzazione della documentazione di riferimento dell'API

Gli utenti del portale possono visualizzare la documentazione di riferimento dell'API che hai pubblicato sul tuo portale, come segue:

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, puoi filtrare l'elenco delle API per categoria, titolo o descrizione utilizzando gli strumenti nel riquadro a sinistra.

4. Fai clic su una scheda dell'API per visualizzare la relativa documentazione di riferimento.
   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 dell'API. Consulta Pubblicazione delle API per ulteriori informazioni su come viene visualizzata la documentazione di riferimento dell'API.

Condivisione della responsabilità di un'app tramite i team di sviluppatori (beta)

Nota: devi aver effettuato la registrazione alla versione beta 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 seguenti sezioni descrivono come creare e gestire i team di sviluppatori.

Punto chiave:quando navigano nel portale per gli sviluppatori, i team di sviluppatori vengono chiamati semplicemente "team".

Informazioni sui ruoli del team di sviluppatori

La seguente tabella riassume i ruoli che puoi assegnare ai membri del team di sviluppatori:

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 di un team.

Ruolo	Descrizione
Amministratore app	Privilegi di sola lettura per i membri del team di sviluppatori e i relativi dettagli. Privilegi di lettura e scrittura per le app.
Owner	Privilegi completi di lettura e scrittura per i membri del team di sviluppatori, i dettagli del team di sviluppatori e le app.
Viewer	Privilegi di sola lettura per i membri del team di sviluppatori, i dettagli del team di sviluppatori e le app.

Visualizzare la pagina Teams

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 degli account utente nel portale.

Viene visualizzata la pagina Teams che ti consente di:

• Visualizzare 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 al team di sviluppatori e i relativi ruoli, rimuovi te stesso da un team di sviluppatori o elimina un team facendo clic sulla riga del team di sviluppatori.

Aggiunta dei team di sviluppatori

Nota: gli utenti del portale possono visualizzare i team di sviluppatori di cui sono membri nella pagina Team. Per la versione beta, 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 degli 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 di team di sviluppatori.

   Ripeti la procedura per aggiungere altri membri.

   Nota:

   • Il tuo ruolo viene 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 sulla accanto al membro del team che vuoi eliminare.

7. Fai clic su Crea.

Modifica dei membri e dei ruoli del team di sviluppatori

Per modificare i membri e i ruoli del team di sviluppatori:

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

4. Esegui uno o più dei seguenti passaggi:

   • Modifica il nome, la descrizione e il contatto principale.
   • Aggiungi o rimuovi membri del team di sviluppatori.
   • Aggiornare 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.

Rimuovere il tuo account 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 di team di sviluppatori, a meno che tu non sia il proprietario di un team.

Per rimuovere te stesso da un team di sviluppatori:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa degli account utente nel portale.
3. Fai clic sulla riga del team di sviluppatori da cui vuoi rimuovere te stesso.
4. Fai clic su Abbandona team.

Eliminazione di un team di sviluppatori

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

Per eliminare un team di sviluppatori:

1. Accedi al portale.
2. Seleziona Team dal menu a discesa degli 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 app per sviluppatori e app per il team di sviluppatori, come descritto nelle sezioni seguenti.

Registrazione delle app sviluppatore

Punto chiave: dopo che l'utente del portale ha registrato un'app sviluppatore, i dati dell'account utente vengono sincronizzati e disponibili su Edge nella pagina Sviluppatori. Consulta la sezione Dove vengono memorizzati i dati dell'account dello sviluppatore di app.

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

1. 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 Catalogo API, seleziona una o più API.

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

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

   Per ulteriori informazioni, consulta Informazioni sugli URL di callback.

6. Fai clic su Crea.

Registrazione delle app del team di sviluppatori

Nota: questo passaggio è applicabile solo se hai effettuato la registrazione alla versione beta della funzionalità dei team. Nella versione beta, la proprietà dell'app non può essere trasferita dopo la sua creazione.

I membri del team di sviluppatori possono registrare le app affinché un team di sviluppatori utilizzi le API che hai pubblicato, come descritto di seguito.

Nota: una nuova entità del team di sviluppatori verrà aggiunta a Edge solo dopo che un membro ha registrato un'app per il team. Consulta Dove vengono archiviate le informazioni del team di sviluppatori (beta).

Per saperne di più su come:

• Gli utenti del portale aggiungono e gestiscono team, come descritto in Condivisione della responsabilità di un'app utilizzando i team di sviluppatori (beta).
• I provider di API visualizzano e gestiscono i team di sviluppatori, come descritto in Gestione dei team di sviluppatori (beta).

Per registrare le app del team di sviluppatori:

1. Seleziona Team dal menu a discesa dell'account utente.
2. Fai clic sulla riga relativa al 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 nell'elenco a discesa Proprietario.

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

   Nota: nella versione beta, la proprietà dell'app non può essere trasferita una volta creata.

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

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

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

   Per ulteriori informazioni, consulta Informazioni sugli URL di callback.

8. Fai clic su Crea.

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 Pending Approval indica un'API per la quale l'accesso è stato richiesto, ma non ancora concesso.

Nota: al momento le API non pubblicate non vengono visualizzate; 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 aggiunta di nuovo 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 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 o per abilitare o disabilitare, rispettivamente, l'accesso a un'API dall'app.
4. Per un'API autenticata, aggiungi o modifica l'URL di callback, se necessario.

Visualizzazione della chiave API e del secret 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 Attivo.
   Se la chiave API richiede l'approvazione e non è ancora stata approvata, lo stato verrà visualizzato come 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 o revocati, la chiave API non sarà valida finché l'account utente o l'app non verranno riattivati/riapprovati. Per maggiori informazioni, vedi Attivare e disattivare uno sviluppatore e Approvare o revocare un'app.

Rotazione della chiave API di un'app

Un utente del portale può ruotare la chiave API di un'app periodicamente o in risposta a una potenziale perdita o compromissione. Quando un utente del portale ruota una chiave API, ne viene creata una nuova con gli stessi diritti API della chiave originale. La chiave API originale rimane attiva durante la transizione che non viene più utilizzata. Devi revocare la chiave API precedente per evitare che le relative credenziali vengano accettate, come descritto in Revoca di 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. Facoltativamente, 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 mentre la disattivi. Devi revocare una chiave API per impedire che le relative credenziali vengano accettate.

Gli utenti del portale possono revocare una chiave API per un'app dal portale, in questo 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 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 in Revocato.

Modifica dei dettagli sull'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. Gestione delle API in un'app, come richiesto.
5. Fai clic su Salva.

Eliminazione di 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 di app.