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 sviluppatori di app di registrare, accedere e gestire le app che utilizzeranno le tue API.
Le seguenti sezioni descrivono in che modo gli sviluppatori di app interagiscono con il tuo portale:
Come vengono monitorati la registrazione e l'accesso degli sviluppatori di app in Edge
La registrazione degli sviluppatori e l'accesso al portale vengono monitorati utilizzando l'attributo personalizzato _apiportal in Edge.
Quando uno sviluppatore si registra autonomamente, alla configurazione viene aggiunto l'attributo personalizzato _apiportal e lo stato sviluppatore viene impostato su unverified, per indicare che lo sviluppatore non ha eseguito l'accesso al portale. Ad esempio: {"status":"unverified","portals":{}}
La prima volta che lo sviluppatore accede a un portale, l'attributo personalizzato _apiportal viene aggiornato per monitorare il nome e l'ora di accesso del portale e viene impostato lo stato sviluppatore su active. Ogni volta che lo sviluppatore accede al portale, l'attributo personalizzato viene aggiornato in modo da reimpostare il valore lastVisit (in formato epoca) per il portale in questione. Ad esempio: {"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}
Registra un account sviluppatore di app
Prima che gli sviluppatori di app possano utilizzare le tue API, devono registrarsi creando un account.
Quando uno sviluppatore di app si registra al tuo portale:
- Le informazioni dello sviluppatore di app vengono create e archiviate su Edge. Vedi Dove vengono memorizzati i dati dell'account sviluppatore.
- Lo sviluppatore di app viene visualizzato nell'elenco degli sviluppatori di app registrati. Vedi Esplorare la pagina Sviluppatori.
In alternativa, puoi registrare gli sviluppatori di app per loro conto utilizzando l'interfaccia utente Edge, come descritto nella sezione Registrare gli sviluppatori di app.
I nuovi sviluppatori di app possono autoregistrarsi sul portale nel seguente modo:
- Vai al portale.
- Fai clic su Accedi.
Fai clic su Registrati.
Viene visualizzata la finestra di dialogo che segue.
Inserisci le informazioni richieste (nome, cognome e indirizzo email).
Fai clic su Crea.
Viene visualizzata la finestra di dialogo che segue.
Fai clic sul link sicuro nell'email per aprire il portale e stabilire la sessione autenticata.
Accedi al tuo portale
Dopo essersi registrati al portale, gli sviluppatori di app accedono utilizzando la pagina di accesso.
Ogni volta che uno sviluppatore di app accede a un portale, anziché utilizzare un secret condiviso come una password per autenticare lo sviluppatore, viene inviato un link sicuro per verificare l'identità e stabilire una sessione con il portale.
Gli sviluppatori di app possono accedere al tuo portale nel seguente modo:
- Vai al portale.
- Fai clic su Accedi.
- Inserisci l'indirizzo email associato all'account.
Fai clic su Accedi.
Viene visualizzata la finestra di dialogo che segue.
Fai clic sul link sicuro nell'email per aprire il portale e stabilire la sessione autenticata.
Registra app
Dopo aver eseguito l'accesso al portale, gli sviluppatori di app possono registrare le app per utilizzare i prodotti API che hai pubblicato, come indicato di seguito:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic su + App per creare una nuova app.
- Inserisci un nome e una descrizione per l'app nella finestra di dialogo Crea app.
- Fai clic su Crea.
- Gestisci i prodotti basati su API nell'app, come descritto di seguito.
Gestire i prodotti basati su API in un'app
Gli sviluppatori di app possono gestire i prodotti API nelle proprie app. I prodotti basati su API vengono aggiunti alla pagina dei dettagli dell'app. Per alcuni prodotti basati su API, l'approvazione non è automatica. Lo stato In attesa indica un prodotto API per il quale l'accesso è stato richiesto, ma non ancora concesso.
Gli sviluppatori di app possono gestire i prodotti API in un'app dal tuo portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic sul nome dell'app.
- Fai clic su Gestisci prodotti.
Fai clic sul pulsante di attivazione/disattivazione Accesso per attivare o disattivare l'accesso a un prodotto API dall'app.
Nota: se lo sviluppatore dell'app disattiva l'accesso a un prodotto API che è privato o solo interno, il prodotto API viene rimosso dall'app e deve essere aggiunto di nuovo manualmente dall'amministratore del portale, come descritto in Registrare app e gestire le chiavi API.
Fai clic su Richiedi per richiedere l'approvazione di un prodotto API non ancora consentito.
Fai clic su Salva.
Visualizzare la chiave API per un'app
Gli sviluppatori di app possono gestire la chiave API per un'app dal tuo portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic sul nome dell'app.
- Visualizza la chiave API nella sezione Chiavi.
- Fai clic su Visualizza secret per visualizzare il secret della chiave API.
- Conferma che lo stato della chiave API sia Approvato.
Ruotare la chiave API per un'app
Uno sviluppatore di app può ruotare la chiave API di un'app periodicamente o in risposta a una potenziale fuga o compromissione. Quando uno sviluppatore di app ruota una chiave API, ne viene creata una nuova con gli stessi diritti del prodotto API della chiave originale. La chiave API originale è contrassegnata come deprecata, ma rimane attiva durante la transizione non più in uso. Devi disattivare una chiave deprecata per evitare che le relative credenziali vengano accettate, come descritto nella sezione Disattivazione di una chiave API per un'app.
Gli sviluppatori di app possono ruotare la chiave API principale di un'app dal tuo portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic sul nome dell'app.
- Nella sezione Chiavi, posiziona il cursore sulla chiave API corrente per visualizzare il menu delle azioni.
- Fai clic su
per espandere il menu delle azioni. - Fai clic su Ruota.
- Fai clic su Crea nella finestra di dialogo per confermare l'operazione.
- Facoltativamente, disattiva la chiave API, come descritto di seguito.
Disattivare una chiave API per un'app
Quando uno sviluppatore di app ruota una chiave API, come descritto nella sezione precedente, quest'ultima viene contrassegnata come deprecata, ma rimane attiva durante la transizione non più in uso. Devi disattivare una chiave deprecata per evitare che le relative credenziali vengano accettate.
Gli sviluppatori di app possono disattivare una chiave API per un'app dal tuo portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic sul nome dell'app.
- Nella sezione Chiavi, fai clic su Cronologia chiavi per visualizzare l'elenco delle chiavi ritirate.
- Posiziona il cursore sulla chiave API ritirata che vuoi disattivare per visualizzare il menu Azioni.
- Fai clic su per espandere il menu delle azioni.
- Fai clic su Disattiva.
- Fai clic su Disattiva per confermare l'operazione.
Lo stato della chiave viene aggiornato su Revocato.
Modifica dettagli app
Gli sviluppatori di app possono modificare i relativi dettagli nel seguente modo:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic sul nome dell'app.
- Modificare i campi Nome o Descrizione.
- Fai clic su Salva.
L'app viene eliminata e rimossa dall'elenco Le mie app.
Elimina un'app
Gli sviluppatori di app possono eliminare un'app dal portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa degli utenti.
- Fai clic sul nome dell'app.
- Fai clic su Elimina nell'angolo in alto a destra della pagina.
L'app viene eliminata e rimossa dall'elenco Le mie app.