Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
Il portale per sviluppatori consente agli sviluppatori di app di registrarsi, accedere e gestire le app che utilizzeranno le tue API.
Le sezioni seguenti 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, l'attributo personalizzato _apiportal viene aggiunto alla configurazione dello sviluppatore e lo stato dello 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 al portale e impostare lo stato dello sviluppatore su active. Ogni volta che lo sviluppatore accede al portale, l'attributo personalizzato viene aggiornato per reimpostare il valore lastVisit (in formato epoch) per quel portale. 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 sullo sviluppatore dell'app vengono create e archiviate su Edge. Consulta Dove vengono archiviati i dati dell'account sviluppatore.
- Lo sviluppatore di app viene visualizzato nell'elenco degli sviluppatori di app registrati. Consulta la sezione Esplorare la pagina Sviluppatori.
In alternativa, puoi registrare gli sviluppatori di app per loro conto utilizzando l'interfaccia utente di Edge, come descritto in Registrazione degli sviluppatori di app.
I nuovi sviluppatori di app possono registrarsi autonomamente al tuo portale nel seguente modo:
- Vai al portale.
- Fai clic su Accedi.
Fai clic su Registrati.
Viene visualizzata la seguente finestra di dialogo.
Inserisci le informazioni richieste (nome, cognome e indirizzo email).
Fai clic su Crea.
Viene visualizzata la seguente finestra di dialogo.
Fai clic sul link sicuro nell'email per aprire il portale e stabilire la sessione autenticata.
Accedi al tuo portale
Dopo aver effettuato la registrazione al tuo portale, gli sviluppatori di app accedono utilizzando la pagina Accedi.
Ogni volta che uno sviluppatore di app accede a un portale, anziché utilizzare un segreto condiviso come una password per autenticarlo, 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 seguente finestra di dialogo.
Fai clic sul link sicuro nell'email per aprire il portale e stabilire la sessione autenticata.
Registra le app
Dopo aver eseguito l'accesso al portale, gli sviluppatori di app possono registrare le app per utilizzare i prodotti API che hai pubblicato nel seguente modo:
- Seleziona Le mie app dal menu a discesa dell'utente.
- 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 API nell'app, come descritto di seguito.
Gestire i prodotti API in un'app
Gli sviluppatori di app possono gestire i prodotti API nelle loro app. I prodotti API vengono aggiunti alla pagina dei dettagli dell'app. Per alcuni prodotti API, l'approvazione non è automatica. Lo stato Pending indica un prodotto API per cui è stato richiesto l'accesso, ma non è stato 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 dell'utente.
- 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 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 le 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 di un'app
Gli sviluppatori di app possono gestire la chiave API di un'app dal tuo portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa dell'utente.
- Fai clic sul nome dell'app.
- Visualizza la chiave API nella sezione Chiavi.
- Fai clic su Visualizza segreto per visualizzare la chiave segreta della chiave API.
- Verifica che lo stato della chiave API sia Approvato.
Ruotare la chiave API di un'app
Uno sviluppatore di app può ruotare la chiave API di un'app periodicamente o in risposta a una potenziale fuga di dati o compromissione. Quando uno sviluppatore di app ruota una chiave API, viene creata una nuova chiave API con gli stessi diritti di prodotto API della chiave originale. La chiave API originale è contrassegnata come deprecata, ma rimane attiva durante la transizione al ritiro. Devi disattivare una chiave ritirata per impedire l'accettazione delle relative credenziali, come descritto in Disattivare 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 dell'utente.
- Fai clic sul nome dell'app.
- Nella sezione Chiavi, posiziona il cursore sopra la 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.
- Se vuoi, disattiva la chiave API come descritto di seguito.
Disattivare una chiave API per un'app
Quando uno sviluppatore di app esegue la rotazione di una chiave API, come descritto nella sezione precedente, la chiave API viene contrassegnata come ritirata, ma rimane attiva durante la transizione al ritiro. Devi disattivare una chiave ritirata per impedire l'accettazione delle relative credenziali.
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 dell'utente.
- 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 deprecata che vuoi disattivare per visualizzare il menu delle 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 in Revocato.
Modificare i dettagli dell'app
Gli sviluppatori di app possono modificare i dettagli dell'app come segue:
- Seleziona Le mie app dal menu a discesa dell'utente.
- Fai clic sul nome dell'app.
- Modifica 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 tuo portale nel seguente modo:
- Seleziona Le mie app dal menu a discesa dell'utente.
- 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.