In che modo gli utenti interagiscono con il portale

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

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

Le seguenti sezioni descrivono in che modo gli utenti interagiscono con quest'ultimo.

Accesso al portale in corso...

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

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

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 nella sezione 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 seguenti sezioni:

• Creare un account utente nel portale integrato
• Accedi 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 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 l'interfaccia utente di gestione perimetrale, come descritto in Registrare gli sviluppatori di app, questo non è consigliato per garantire che gli account utente sul portale integrato e i record degli sviluppatori su Edge rimangano sincronizzati.

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

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 composte 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 eseguito 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 verrà incoraggiato 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 dell'avvio, come descritto in Configurare il server SMTP.

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

   Se non fai clic sul link entro 10 minuti, devi ripetere i passaggi di questa procedura per creare un account e visualizzare nuovamente 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 sono stati approvati, accedono utilizzando le loro 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 gli account utente manualmente prima che gli utenti del portale possano accedere. Al momento, agli utenti del portale non viene fornita alcuna indicazione che la loro registrazione deve essere attivata manualmente prima di poter accedere. È consigliabile configurare l'attivazione manuale per velocizzare l'attivazione dei nuovi account utente.
• Per andare direttamente alla pagina di accesso, usa 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).
   Nella pagina di accesso vengono visualizzati:
   
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 nel seguente modo:

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.

   All'email viene inviato un link per la reimpostazione della password.

   Nota: per configurare il server SMTP, consulta Configurare il server SMTP.

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

7. Inserisci la nuova password e confermala.

   Le password devono essere composte 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.

Accedere al portale utilizzando l'autenticazione SAML (beta)

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

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

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

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

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

   Ti reindirizzeremo 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 portale, come indicato di seguito:

1. Vai al portale.

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

3. Puoi filtrare l'elenco delle API per categoria, titolo o descrizione, se lo desideri, utilizzando gli strumenti nel riquadro di 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 conoscere e provare le API o scaricare il documento utilizzato per eseguire il rendering della documentazione di riferimento delle API. Consulta la sezione Pubblicazione delle API per ulteriori informazioni sul rendering della documentazione di riferimento delle API.

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

Nota: devi aver eseguito la registrazione alla release beta della funzionalità dei 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 semplicemente chiamati semplicemente "team".

Informazioni sui ruoli del team di sviluppatori

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

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

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.
Proprietario	Privilegi di lettura e scrittura completi per i membri del team di sviluppatori, i relativi dettagli e le app.
Visualizzatore	Privilegi di sola lettura per i membri del team di sviluppatori, i relativi dettagli e le app.

Visualizzazione della pagina Team

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

Per accedere alla pagina Team:

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:

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

Aggiunta di 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 viene inviata alcuna notifica 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 del team di sviluppatori.

   Ripeti la procedura per aggiungere altri membri.

   Nota:

   • Verrai 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 di sviluppatori che vuoi eliminare.

7. Fai clic su Crea.

Modificare l'appartenenza al team di sviluppatori e i relativi ruoli

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

1. Accedi al portale.
2. Seleziona Team dal menu a discesa degli account utente nel portale.
3. Fai clic nella riga relativa al 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 dal 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 di sviluppatori.

Per rimuovere il tuo account 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 Lascia il 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 le app degli sviluppatori e le app del team di sviluppatori, come descritto nelle sezioni che seguono.

Registrazione delle app per sviluppatori

Punto chiave: dopo che l'utente del portale ha registrato un'app sviluppatore, i dati dell'account utente vengono sincronizzati e sono disponibili su Edge nella pagina Sviluppatori. Vedi Dove vengono memorizzati 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. Seleziona App dal menu a discesa degli 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. Devi selezionare almeno un'API per creare un'app.

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 release beta della funzionalità per i team. Nella versione beta, la proprietà dell'app non può essere trasferita dopo la creazione dell'app.

I membri del team di sviluppatori possono registrare 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 la pagina Dove vengono archiviate le informazioni del team di sviluppatori (beta).

Per scoprire di più su come:

• Gli utenti del portale aggiungono e gestiscono i team, come descritto nella sezione Condividere la responsabilità di un'app tramite i team di sviluppatori (beta).
• I fornitori di API visualizzano e gestiscono i team di sviluppatori, come descritto in Gestire i 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 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 nell'elenco a discesa Proprietario.

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

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

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. Devi selezionare almeno un'API per creare un'app.

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, devi pubblicare API per consentire agli utenti del portale di utilizzare i tuoi prodotti API.

Gli utenti del portale possono gestire 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 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 disabilita l'accesso a un'API privata o solo interna, l'API viene rimossa dall'app e deve essere aggiunta nuovamente manualmente dall'amministratore del portale, come descritto in Controllare l'accesso alle API registrando le app.

Gli utenti del portale possono gestire le API in un'app dal portale, come indicato di seguito:

1. Seleziona App dal menu a discesa degli 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 in base alle esigenze.

Visualizzazione della chiave e del secret API di un'app

Gli utenti del portale possono gestire la chiave API per un'app dal tuo portale, come indicato di seguito:

1. Seleziona App dal menu a discesa degli 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 tua chiave API richiede l'approvazione e non è ancora stata approvata, lo stato visualizzato sarà In attesa di approvazione.
5. Fai clic su Mostra secret per visualizzare il secret.
6. Posiziona il cursore sul secret o sulla chiave API e fai clic su per copiarlo negli appunti.

Nota: se l'account o l'app utente sono stati disattivati/revocati, la chiave API non sarà valida fino a quando l'account o l'app utente non viene riattivata/riapprovata. Per maggiori informazioni, consulta Attivare e disattivare uno sviluppatore e Approvare o revocare un'app.

Rotazione della chiave API per un'app

Un utente del portale può ruotare la chiave API di un'app periodicamente o in risposta a una potenziale fuga di notizie 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 da fuori uso. Devi revocare la vecchia chiave API per evitare che le relative credenziali vengano accettate, come descritto in Revocare una chiave API per un'app.

Gli utenti del portale possono ruotare una chiave API per un'app dal tuo portale, come indicato di seguito:

1. Seleziona App dal menu a discesa degli account utente.
2. Fai clic sull'app nell'elenco.
3. Nella sezione API Keys (Chiavi API), fai clic su Add Key (Aggiungi chiave).
4. Fai clic su Conferma nella finestra di dialogo per confermare l'operazione.
5. Se vuoi, 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 evitare che le relative credenziali vengano accettate.

Gli utenti del portale possono revocare una chiave API per un'app dal portale, come descritto di seguito:

1. Seleziona App dal menu a discesa degli 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 desideri revocare.

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

   Lo stato della chiave viene aggiornato in Revocata.

Modifica dei dettagli dell'app

Gli utenti del portale possono modificare i dettagli dell'app, come indicato di seguito:

1. Seleziona App dal menu a discesa degli 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, se necessario.
5. Fai clic su Salva.

Eliminazione di un'app

Gli utenti del portale possono eliminare un'app dal portale, come descritto di seguito:

1. Seleziona App dal menu a discesa degli 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.