In che modo gli utenti del portale interagiscono con il portale

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

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 del portale interagiscono con quest'ultimo.

Accedi al portale

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 per accedere.

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

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:

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

Gli utenti del portale creano un account utente 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.

    Finestra di dialogo Crea il tuo account

  4. Compila il modulo.

    Devi inserire i valori in tutti i campi obbligatori. Le password devono contenere 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.

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

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

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

    Se non fai clic sul collegamento entro 10 minuti, devi ripetere i passaggi della procedura per creare un account e ricevere una nuova richiesta.

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

Accedi 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).

Gli utenti del portale accedono come segue:

  1. Vai al portale.
  2. Fai clic su Accedi. Nella pagina di accesso vengono visualizzati: Pagina di accesso
  3. Inserisci l'indirizzo email e la password.
  4. Fai clic su Accedi.

Cambiare la 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.

    Viene inviato un link per la reimpostazione della password all'indirizzo email.

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

  7. Inserisci la nuova password e confermala.

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

Accedi al portale utilizzando l'autenticazione SAML (beta)

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

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

    Ti reindirizzeremo al provider SAML.

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

Visualizza la documentazione Riferimento 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:

    pagina API

  3. Filtra l'elenco delle API per categoria, titolo o descrizione, se disattivato, 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 scoprire e provare le API o scaricare il documento utilizzato per eseguire il rendering della documentazione di riferimento dell'API. Consulta la sezione Pubblicare le API per saperne di più su come viene visualizzata la documentazione di riferimento delle API.

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

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.

Informazioni sui ruoli del team di sviluppatori

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

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

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

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

  7. Fai clic su Crea.

Modificare le iscrizioni e i ruoli del team di sviluppatori

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

  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 modificare e di cui sei proprietario.

  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.
    • Aggiorna i ruoli dei membri del team di sviluppatori.

  5. Fai clic su Salva.

Rimuovere te stesso da un team di sviluppatori

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.

Eliminare un team di sviluppatori

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 icona elimina.
  5. Fai clic su Conferma per confermare l'eliminazione.

Registra app

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

Registra le app degli sviluppatori

Gli utenti del portale possono registrare le app per utilizzare le API che hai pubblicato, come indicato di seguito:

  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. Seleziona il proprietario dell'app dall'elenco a discesa Proprietario.

    Per impostazione predefinita, sei il proprietario dell'app. Se vuoi, seleziona un team di sviluppatori dal menu a discesa per condividere la responsabilità dell'app con altri membri del team di sviluppatori. Leggi l'articolo Condividere la responsabilità di un'app utilizzando i team di sviluppatori (beta).

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

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

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

  7. Fai clic su Crea.

Registra le app del team di sviluppatori

I membri del team di sviluppatori possono registrare le app per consentire a un team di sviluppatori di utilizzare le API da te pubblicate, come descritto di seguito.

Per saperne di più su come:

Per registrare le app del team di sviluppatori:

  1. Seleziona Team dal menu a discesa degli 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 sviluppatori è il proprietario dell'app. Se vuoi, seleziona un team di sviluppatori diverso o seleziona te come proprietario dal menu a discesa.

  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 saperne di più, consulta Informazioni sugli URL di callback.

  8. Fai clic su Crea.

Gestisci le API in un'app

In qualità di producer di API, devi pubblicare API per consentire agli utenti del portale di utilizzare i tuoi prodotti API.

Gli utenti del portale gestiscono le API utilizzate dalle proprie 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.

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

  1. Seleziona App dal menu a discesa degli account utente.
  2. Fai clic sull'app nell'elenco.
  3. Nella sezione API, fai clic su icona di attivazione o icona di disattivazione per abilitare o disabilitare l'accesso, rispettivamente, a un'API dall'app.
  4. Per un'API autenticata, aggiungi o modifica l'URL di callback, come richiesto.

Visualizzare la chiave e il secret API 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 degli account utente.
  2. Fai clic sull'app nell'elenco.
  3. Visualizza le chiavi API nella sezione Chiavi API.
  4. Conferma che lo stato della chiave API sia Attivo. Se la 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 sulla chiave API o sul secret e fai clic su icona-elimina per copiarlo negli appunti.

Ruotare la chiave API per un'app

L'utente del portale può ruotare la chiave API di un'app periodicamente o in risposta a una potenziale fuga 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 non più utilizzata. Devi revocare la vecchia chiave API per evitare che le relative credenziali vengano accettate, come descritto nella sezione Revocare una chiave API per un'app.

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

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

Revocare 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 non più utilizzata. 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 nel tuo portale, come indicato 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 icona revoca nella colonna Azioni associata alla chiave API da revocare.

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

    Lo stato della chiave viene aggiornato in Revocato.

Modifica dettagli app

Gli utenti del portale possono modificare i dettagli dell'app come segue:

  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. Gestisci le API in un'app, se necessario.
  5. Fai clic su Salva.

Elimina 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 App.