Comunicazione tra un portale basato su Drupal ed Edge

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

Il portale Servizi per gli sviluppatori funge da client per Apigee Edge. Ciò significa che il portale non funziona come un sistema autonomo. Invece, gran parte delle informazioni utilizzate dal portale viene effettivamente archiviata su Edge. Se necessario, il portale effettua una richiesta HTTP o HTTPS per recuperare informazioni da Edge o per inviare informazioni a Edge.

Edge non invia richieste al portale, ma risponde solo a quelle effettuate da quest'ultimo. Di conseguenza, tutte le interazioni tra il portale ed Edge vengono avviate dal portale.

Configura la connessione tra il portale ed Edge

Come indicato di seguito, il portale deve comunicare con Edge e sono tre le informazioni necessarie.

  • URL dell'endpoint edge

    L'endpoint predefinito per la versione basata su cloud di Edge è https://api.enterprise.apigee.com/v1.

    Per l'installazione Private Cloud, il formato dell'URL è: http://EdgePrivateCloudIp:8080/v1 o https://EdgePrivateCloudIp:TLSport/v1.

    Dove EdgePrivateCloudIp è l'indirizzo IP del server Edge Management Server e TLSport è la porta TLS/SSL per l'API di gestione perimetrale. Ad esempio, 8443.
  • Nome organizzazione Apigee

    Questo è il nome della tua organizzazione su Edge. Puoi configurare l'organizzazione quando crei l'account su Edge.
  • Nome utente e password di un amministratore sviluppatore

    Le chiamate dal portale a Edge sono autenticate e richiedono un utente con privilegi di Amministratore sviluppatore. Quando viene eseguito il provisioning di un Portale per gli sviluppatori per te, il ruolo Amministratore sviluppatore viene aggiunto alla tua organizzazione. Questo ruolo, che include un singolo utente denominato devadmin+{org_name}@apigee.com, ha il solo scopo di connettere il tuo Portale per gli sviluppatori alla tua organizzazione Edge. Poiché il portale visualizza le app per sviluppatori Edge, i prodotti API e così via, deve rimanere sincronizzato con la tua organizzazione Edge effettuando chiamate API di gestione che richiedono l'autenticazione. L'"utente" devadmin dispone delle autorizzazioni necessarie.

Per visualizzare le informazioni di connessione:

  1. Nel menu di amministrazione di Drupal, seleziona Configuration > Dev Portal > Application Settings (Configurazione > Portale di sviluppo > Impostazioni applicazione).

Per modificare la configurazione:

La modalità di modifica della configurazione dipende dall'installazione e dalla versione del portale:

  • Installazione basata su cloud della versione del portale 15.01.06 e successive: devi inoltrare una richiesta all'assistenza Apigee Edge per modificare le informazioni di connessione. Ad esempio, se vuoi modificare il nome dell'organizzazione.
  • Installazione on-premise e portale basato su cloud precedente alla versione 15.01.06: modifica le informazioni di connessione come descritto di seguito:
  1. Nel menu di amministrazione di Drupal, seleziona Configuration > Dev Portal Settings (Configurazione > Impostazioni portale per sviluppatori).
  2. Inserisci il nome dell'organizzazione in Organizzazione dell'API di gestione.
  3. Inserisci l'URL dell'endpoint Edge in URL endpoint API di gestione.
  4. Inserisci le credenziali dell'amministratore dell'organizzazione in Utente autenticato endpoint e Password dell'utente autenticato.
  5. Seleziona Test Connection (Verifica connessione) per accertarti che il collegamento vada a buon fine.
  6. Seleziona Save Configuration (Salva configurazione).

Garantire l'accesso a Edge dal portale

Poiché gran parte delle informazioni utilizzate dal portale sono archiviate su Edge, devi assicurarti che il portale possa accedere a Edge. Il portale avvia la comunicazione con Edge effettuando richieste REST tramite HTTP e HTTPS. Ad esempio, quando uno sviluppatore registra una nuova app sul portale, il portale invia una richiesta a Edge per inviare informazioni sull'app.

È possibile eseguire il deployment sia di Edge che del portale nel cloud o on-prem e puoi combinare vari tipi di deployment. Ad esempio, puoi eseguire il deployment sia nel cloud, sia on-prem, sia nel cloud e uno on-prem:

  • Se viene eseguito il deployment sia del portale che di Edge da Apigee nel cloud, non dovrebbero verificarsi problemi nell'invio di richieste dal portale a Edge.
  • Se esegui il deployment del portale on-prem, devi assicurarti che il portale possa effettuare richieste a Edge, indipendentemente dal fatto che il deployment di Edge sia stato eseguito nel cloud o on-prem.
  • Se esegui il deployment di Edge on-prem, devi assicurarti che il portale abbia accesso a Edge. Ciò significa che il tuo Edge Server deve accettare le richieste dal portale a prescindere dal fatto che il deployment del portale sia stato eseguito nel cloud o on-prem.

Video: guarda un breve video per scoprire di più su come il portale per gli sviluppatori comunica con Apigee Edge e per garantire che la connessione funzioni.

Gestione di app e chiavi API dal portale

Quando lo sviluppatore completa il processo di registrazione dell'app sul portale, il portale invia informazioni sull'app a Edge, tra cui il nome e i prodotti API associati all'app.

Se Edge registra correttamente l'app, restituisce una singola chiave API al portale. Lo sviluppatore utilizza quindi la chiave API per accedere ai prodotti API associati all'app.

Sul portale non vengono effettivamente archiviate informazioni su app e chiavi API. Invece, tutte queste informazioni vengono archiviate su Edge. Pertanto, ogni volta che uno sviluppatore utilizza il portale per visualizzare informazioni su un'app, il portale invia una richiesta a Edge per accedere a queste informazioni. Ogni volta che lo sviluppatore modifica un'app, il portale invia automaticamente le modifiche a Edge.

Ad esempio, uno sviluppatore accede al portale e va alla pagina Le mie app. Per completare la pagina Le mie app, il portale invia una richiesta a Edge per recuperare informazioni sulle app e sulle chiavi API dello sviluppatore. Tali informazioni vengono quindi visualizzate nella pagina Le mie app dello sviluppatore nel portale:

Se poi lo sviluppatore aggiunge, rimuove o modifica un'app, il portale invia queste modifiche a Edge.

Poiché tutte le informazioni sulle app e sulle chiavi API sono archiviate su Edge, un amministratore di Edge può manipolare queste informazioni utilizzando la UI di Edge. Ad esempio, un amministratore può:

  • Aggiungere, rimuovere o modificare l'app di uno sviluppatore
  • Revocare o approvare una chiave API per un'app

Di seguito viene mostrata la stessa app, "My Weather App", così come viene visualizzata dall'amministratore nella UI di Edge:

Gestire gli sviluppatori dal portale

Quando uno sviluppatore si registra come nuovo utente del portale, viene creato su Edge e sul portale. Di conseguenza, a differenza delle app e delle chiavi API, le informazioni sugli sviluppatori vengono effettivamente archiviate sia su Edge che sul portale.

Le informazioni per sviluppatori archiviate su Edge includono:

  • Nome
  • Cognome
  • Indirizzo email
  • Informazioni aggiuntive facoltative inviate dal portale

Il portale archivia le stesse informazioni di Edge, ma ne archivia anche informazioni aggiuntive, tra cui:

  • Password portale
  • Stato dell'account del portale: attivo o bloccato
  • Ruolo del portale: utente autenticato, amministratore, altro
  • Autorizzazioni basate sul ruolo: determinano le azioni che lo sviluppatore può eseguire sul portale

Quando uno sviluppatore accede al portale, quest'ultimo è responsabile dell'autenticazione dello sviluppatore e dell'applicazione delle autorizzazioni basate sui ruoli.

Poiché il portale archivia tutte le informazioni su uno sviluppatore, considera il portale come il sistema di registrazione per le informazioni degli sviluppatori, non Edge. Quando lo sviluppatore modifica le proprie informazioni sul portale, queste vengono archiviate nel portale e, se applicabile, inviate a Edge. Ad esempio, se lo sviluppatore cambia il nome, queste informazioni vengono inviate a Edge. Tuttavia, se lo sviluppatore cambia la password, le informazioni vengono archiviate solo localmente sul portale.

Per maggiori informazioni, consulta Aggiungere e gestire account utente.

Sincronizzare gli sviluppatori di app tra il portale ed Edge

Edge non avvia la comunicazione con il portale. Se, in qualità di amministratore di Edge, manipoli le informazioni su uno sviluppatore nella UI di Edge, non hai la certezza che queste informazioni vengano trasferite al portale. Quindi, utilizza le funzionalità di amministrazione del portale, non Edge, per creare, modificare ed eliminare gli sviluppatori.

Un amministratore del portale può forzare una sincronizzazione tra il portale ed Edge per scaricare le informazioni sul portale da Edge. Tuttavia, se modifichi gli sviluppatori solo sul portale e non su Edge, non dovresti mai dover eseguire questa sincronizzazione. Inoltre, poiché Edge non ti consente di impostare una password quando crei uno sviluppatore, la password del portale di ogni sviluppatore creato su Edge viene impostata su un valore casuale. Di conseguenza, lo sviluppatore deve eseguire la procedura di recupero della password prima di poter accedere al portale.

Per sincronizzare il portale con gli sviluppatori di app su Edge

:
  • Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  • Seleziona People (Persone) nel menu di amministrazione di Drupal.
  • Seleziona il pulsante Dev Portal Developer Sync (Sincronizzazione sviluppatori portale per sviluppatori) nella parte superiore della pagina per eseguire la sincronizzazione con gli sviluppatori di app su Edge.