Configurazione della registrazione delle app

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

Gli sviluppatori utilizzano la pagina Le mie app sul portale Servizi per gli sviluppatori per registrare le app. Gli sviluppatori accedono alla pagina Le mie app dal menu principale del portale:

Per registrare una nuova applicazione, lo sviluppatore seleziona il pulsante Aggiungi una nuova applicazione nella pagina Le mie applicazioni.

Il portale visualizza quindi il modulo di registrazione dell'app predefinito:

Per impostazione predefinita, lo sviluppatore deve specificare solo il nome dell'app, l'URL di callback e l'elenco dei prodotti API da aggiungere all'app.

In qualità di provider di API, hai il controllo completo del processo di registrazione dell'app. Ad esempio, puoi configurare:

  • L'elenco dei prodotti basati su API disponibili sul portale
  • Se è presente un prodotto API predefinito
  • Indica se l'URL di callback è obbligatorio
  • Indica se la chiave API è stata approvata manualmente o automaticamente per un prodotto API
  • Se sono necessarie altre informazioni nella pagina Aggiungi app per registrare l'app

Questo argomento descrive come configurare il processo di registrazione dell'app per il portale. Tuttavia, questo argomento non descrive come creare prodotti basati su API. Per ulteriori informazioni, vedi:

Puoi configurare il portale in modo da impedire agli sviluppatori di creare, eliminare o modificare le app in base al ruolo assegnato allo sviluppatore. Ad esempio, potresti configurare il portale in modo da creare una singola app predefinita per tutti gli sviluppatori al momento della registrazione. Dopodiché, consenti solo ad alcuni sviluppatori di aggiungere nuove app, possibilmente in base a una struttura di tariffe o ad altre caratteristiche dello sviluppatore. Utilizza i ruoli e le autorizzazioni per stabilire quali sviluppatori possono creare, eliminare e modificare le app. Per saperne di più, consulta Aggiungere e gestire gli account utente.

Specifica dei prodotti API disponibili sul portale

Esistono due modi in cui puoi specificare i prodotti API disponibili quando uno sviluppatore accede al portale:

Specificare il livello di accesso durante la creazione di un prodotto API

Quando crei un prodotto API, specifichi l'opzione del livello di accesso del prodotto, come mostrato di seguito:

Per ulteriori informazioni su come il livello di accesso influisce sulla disponibilità del prodotto API nel portale per gli sviluppatori Drupal 7, consulta Livello di accesso.

Limitazione dell'accesso a un prodotto API in base ai ruoli

Abilitando il modulo Drupal Accesso al ruolo del prodotto API, puoi specificare i ruoli che possono accedere a ciascun prodotto API.

Per limitare l'accesso a un prodotto API in base ai ruoli sviluppatore:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Rivedi i ruoli e le assegnazioni degli utenti del portale per sviluppatori:
    • Seleziona Persone > Autorizzazioni > Ruoli nel menu di amministrazione di Drupal e aggiungi o modifica le autorizzazioni e i ruoli sviluppatore, in base alle esigenze.
    • Seleziona Persone nel menu di amministrazione di Drupal e modifica le assegnazioni di utenti e ruoli, in base alle esigenze.
  3. Seleziona Configurazione > Portale di sviluppo > Accesso ruolo prodotto API nel menu di amministrazione di Drupal.
  4. Seleziona i ruoli che devono essere in grado di accedere a ciascun prodotto API.
  5. Fai clic su Salva configurazione.

Configurazione del modo in cui uno sviluppatore associa i prodotti API a un'app

Per registrare una nuova app, uno sviluppatore seleziona il pulsante Aggiungi una nuova app nella pagina Le mie app per aprire il modulo Aggiungi app:

In base alla configurazione del portale, lo sviluppatore può selezionare uno o più prodotti API da associare all'app al momento della registrazione. In alternativa, puoi specificare un prodotto predefinito che viene assegnato a tutte le app.

Sul portale sono disponibili le seguenti opzioni di configurazione per controllare la selezione dei prodotti API durante la registrazione di un'app:

  • Non associare app ad alcun prodotto API.
  • Associa tutte le app a uno o più prodotti API predefiniti (configurati di seguito). Gli sviluppatori non possono aggiungere altri prodotti API all'app.
  • Consenti la selezione di un singolo prodotto API, ma non è obbligatorio.
  • Richiedi la selezione di un singolo prodotto API.
  • Consenti la selezione di più prodotti API, ma non richiederne nessuno.
  • Consenti la selezione di più prodotti API e richiedine almeno uno.

Puoi anche controllare l'elemento HTML visualizzato nel modulo utilizzato dallo sviluppatore per selezionare il prodotto API. Le opzioni disponibili sono le seguenti:

  • Elenchi a discesa.
  • Caselle di controllo o pulsanti di opzione. Le caselle di controllo vengono visualizzate quando lo sviluppatore può selezionare più prodotti API e i pulsanti di opzione vengono visualizzati quando lo sviluppatore può selezionare un solo prodotto API.

Per impostare l'opzione per la selezione dei prodotti API:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Seleziona Configuration > Dev Portal Settings > Application Settings (Configurazione > Impostazioni portale di sviluppo > Impostazioni applicazione) nel menu di amministrazione di Drupal.
  3. Nella pagina Impostazioni applicazione, espandi l'area Impostazioni prodotto API.
  4. In Gestione prodotti API, seleziona l'opzione che controlla la selezione dei prodotti API.
  5. Se specifichi l'opzione "Associa tutte le app a uno o più prodotti API predefiniti (configurati di seguito)", imposta un prodotto predefinito in Prodotto API predefinito.
  6. In Widget del prodotto API, seleziona l'elemento HTML utilizzato dagli sviluppatori per selezionare i prodotti API.
  7. Salva la configurazione.

Configurazione della gestione dell'URL di callback

Se un proxy API nel prodotto API utilizza "OAuth a tre vie" (tipo di concessione del codice di autorizzazione), gli sviluppatori devono specificare un URL di callback quando registrano le proprie app. L'URL di callback in genere specifica l'URL di un'app designata per ricevere un codice di autorizzazione per conto dell'app client. Inoltre, questa stringa URL viene utilizzata per la convalida. Il client deve inviare questo URL ad Apigee Edge quando richiede codici di autorizzazione e token di accesso, e il parametro redirect_uri deve corrispondere a quello registrato. Per maggiori informazioni, consulta Implementazione del tipo di concessione del codice di autorizzazione.

Per controllare l'URL di callback per la selezione dei prodotti API:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Seleziona Configuration > Dev Portal Settings > Application Attributes (Configurazione > Impostazioni portale di sviluppo > Attributi applicazione) nel menu di amministrazione di Drupal.
  3. Nella pagina Impostazioni applicazione, espandi l'area Impostazioni URL di callback.
  4. In Gestione URL di callback, seleziona una delle seguenti opzioni.
    • L'URL di callback è obbligatorio per tutte le app per sviluppatori.
    • L'URL di callback è facoltativo per tutte le app degli sviluppatori.
    • L'URL di callback non è né obbligatorio né visualizzato.
  5. Salva la configurazione.

Visualizzazione delle analisi per l'utilizzo dell'app

Il portale può visualizzare informazioni analitiche sull'utilizzo delle app. Se è attivata la visualizzazione delle analisi, gli sviluppatori di app possono vedere i dati e le analisi nella pagina Le mie app per ogni app. Ad esempio, uno sviluppatore può visualizzare i seguenti dati e analisi per un'app:

  • Velocità effettiva
  • Tempo massimo di risposta
  • Tempo di risposta minimo
  • Numero di messaggi
  • Numero errori

Per attivare l'analisi sul portale:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Seleziona Configuration > Dev Portal > Application Settings (Configurazione > Portale di sviluppo > Application Settings) nel menu di amministrazione di Drupal.
  3. Nella pagina Impostazioni applicazione, espandi l'area Impostazioni prestazioni app.
  4. Seleziona la casella di controllo Mostra la scheda Analisi delle app sviluppatore.
  5. Seleziona Test o Produzione per Ambiente per eseguire query sui dati di analisi. Per un portale disponibile pubblicamente, in genere devi selezionare Produzione.
  6. Salva la configurazione.

Per visualizzare i dati e le analisi sul portale per un'app:

  1. Seleziona il nome dell'app nella pagina Le mie app.
  2. Seleziona il link Analytics per l'app.
  3. Seleziona il tipo di analisi da visualizzare e l'intervallo di date:
  4. Vengono visualizzate le informazioni selezionate:

Approvazione o revoca manuale di una chiave API per un prodotto API

Quando uno sviluppatore aggiunge un prodotto API a un'app e poi registra l'app, il portale restituisce allo sviluppatore la chiave API per l'app, che poi utilizza per accedere ai proxy API associati al prodotto API associato all'app.

Sei tu a controllare la procedura di approvazione delle chiavi per ogni prodotto API quando crei il prodotto API:

La procedura di approvazione può essere:

  • Automatica: il portale per il prodotto API restituisce una chiave API approvata quando lo sviluppatore registra l'app. In seguito puoi revocare una chiave approvata automaticamente.
  • Manuale: il portale restituisce una chiave API quando lo sviluppatore registra l'app, ma la chiave non viene attivata per i prodotti API che utilizzano l'approvazione manuale delle chiavi. Un amministratore deve approvare manualmente la chiave API, nella UI o nell'API di gestione perimetrale, prima che possa essere utilizzata dallo sviluppatore per accedere al prodotto API. In seguito, puoi revocare una chiave approvata manualmente.

Per ulteriori informazioni, consulta Creare prodotti basati su API.

Se il tuo portale consente a uno sviluppatore di aggiungere più prodotti API a un'app, lo sviluppatore potrebbe aggiungere alcuni prodotti con l'approvazione automatica delle chiavi e altri con l'approvazione manuale. Lo sviluppatore può utilizzare immediatamente la chiave API restituita per tutti i prodotti API approvati automaticamente durante l'attesa dell'approvazione finale per i prodotti che richiedono l'approvazione manuale.

Per visualizzare l'elenco dei prodotti API per un'app e lo stato dell'approvazione della chiave per il prodotto API, uno sviluppatore seleziona il nome dell'app nella pagina Le mie app, quindi seleziona il link Prodotti:

In questo esempio, il prodotto API Premium Weather utilizza l'approvazione manuale ed è in attesa che un amministratore approvi la chiave. Il prodotto API senza costi utilizza l'approvazione automatica e l'uso della chiave per accedervi è stato approvato.

Per approvare o revocare manualmente una chiave:

  1. Accedi all'interfaccia utente di gestione perimetrale come utente con privilegi di amministrazione per la tua organizzazione.
  2. Seleziona Piattaforma API nella casella a discesa nell'angolo in alto a destra.
  3. Seleziona Pubblica > App sviluppatore per aprire l'elenco di app sviluppatore.
  4. Seleziona il pulsante In attesa per visualizzare l'elenco delle app con richieste di chiavi in attesa:

  5. Seleziona il nome dell'app che vuoi approvare.
  6. Nella pagina dei dettagli dell'app, seleziona il pulsante Modifica nell'angolo in alto a destra.
  7. Nell'elenco dei prodotti API per l'app, in Azioni:
    • Per approvare la chiave, seleziona il pulsante Approva per ogni prodotto API che richiede l'approvazione manuale.

    • Per revocare una chiave approvata, seleziona il pulsante Revoca in Azioni per un prodotto API al fine di revocare l'accesso.

  8. Salva l'app. La chiave API è stata approvata.

Controllo della memorizzazione nella cache di app e prodotti API

Le informazioni sui prodotti API e sulle app degli sviluppatori vengono archiviate in remoto dal portale su Apigee Edge. Ciò significa che le modifiche ai prodotti e alle app API possono essere eseguite dall'API o dalla UI Edge, senza passare attraverso il portale. Ad esempio, quando un amministratore di backend aggiunge un nuovo prodotto API, il portale non viene aggiornato immediatamente con queste informazioni.

Per assicurarti che il portale rimanga sincronizzato con il backend Edge, puoi attivare manualmente un aggiornamento della cache del portale, aggiornarle automaticamente quando viene eseguito il cron job del portale o entrambe le operazioni. Ad esempio, se configuri il cron job per l'esecuzione frequente, ad esempio ogni 5 o 10 minuti, potresti evitare l'overhead associato all'aggiornamento frequente dei prodotti API e delle cache delle app dello sviluppatore. In questo caso, puoi attivare manualmente l'aggiornamento della cache. Tuttavia, se il cron job viene eseguito ogni ora o due ore, il tempo necessario per aggiornare le cache potrebbe non avere un impatto significativo.

Per impostazione predefinita, il portale è configurato per ricreare le cache del prodotto API e dell'app dello sviluppatore ogni volta che viene eseguito il cron.

Per specificare se ricreare o meno il prodotto API e le cache dell'app dello sviluppatore ogni volta che viene eseguito cron:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Dal menu Drupal, seleziona Configuration > Dev Portal Settings > Application Settings (Configurazione > Impostazioni portale di sviluppo > Impostazioni applicazione).
  3. Seleziona o deseleziona Rebuild API Product and Developer App cache ogni volta che cron viene eseguito.
  4. Salva le impostazioni.

Per aggiornare le cache manualmente:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Dal menu Drupal, seleziona l'icona Home > Svuota tutte le cache.

Personalizzazione dei campi del modulo utilizzati per registrare un'app

Quando lo sviluppatore registra un'app, sul portale viene visualizzato il modulo predefinito:

In qualità di provider di API, potresti modificare questo modulo per chiedere allo sviluppatore di fornire ulteriori informazioni, come l'ID cliente, la piattaforma di destinazione dell'app o altre informazioni. Il portale ti offre la possibilità di aggiungere nuovi campi a questo modulo. Questi campi possono essere:

  • Obbligatorio o facoltativo
  • Visualizzato da diversi elementi HTML, ad esempio caselle di testo, pulsanti di opzione, caselle di controllo e altro ancora
  • Può essere impostato in modo che venga visualizzato in qualsiasi punto del modulo tra il campo URL di callback e il campo Prodotto

Guarda questo video per scoprire come personalizzare il modulo di registrazione dell'app disponibile nel portale per gli sviluppatori.

Ad esempio, il seguente modulo mostra un campo obbligatorio per l'ID cliente e un campo facoltativo per la piattaforma di destinazione:

Quando aggiungi nuovi campi al modulo, questi vengono caricati automaticamente in Edge, insieme a tutti gli altri campi, quando lo sviluppatore invia il modulo. Ciò significa che puoi visualizzare o modificare questi campi su Edge oppure utilizzare l'API di gestione perimetrale per accedere a questi campi da uno script.

Ad esempio, per visualizzare i nuovi campi del modulo nell'interfaccia utente di gestione perimetrale, vai a Pubblica > App sviluppatore e seleziona il nome dell'app. I nuovi valori dei campi vengono visualizzati nell'area Attributi personalizzati della pagina con un nome che corrisponde al nome interno del campo:

I valori dei campi vengono visualizzati anche nell'area Dettagli dell'app nella pagina Le mie app dello sviluppatore:

Lo sviluppatore può anche modificare i valori selezionando il link Modifica relativo all'app nella pagina Le mie app.

Le procedure seguenti descrivono come configurare i moduli per la creazione di app utilizzando l'interfaccia di amministrazione. Uno sviluppatore Drupal può eseguire personalizzazioni aggiuntive, tra cui modificare la pagina "Le mie app", utilizzando hook personalizzati. Per scoprire di più su come modificare i comportamenti tramite il codice, consulta gli esempi di API dell'app nel file: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Per aggiungere un campo al modulo di registrazione dell'app:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Assicurati che il modulo Gestione attributi app DevConnect sia abilitato.
  3. Seleziona Configuration > Dev Portal Settings > Dev Portal App Attributes (Configurazione > Impostazioni portale di sviluppo > Attributi app del portale di sviluppo) nel menu di amministrazione di Drupal.
  4. Seleziona il pulsante Aggiungi attributo app del portale per sviluppatori nella parte superiore della pagina.
  5. Configura il campo. Ad esempio, per il campo ID cliente mostrato sopra, utilizza le seguenti impostazioni:
    • Nome interno = cust_id. Questo è il nome della variabile utilizzata per archiviare il valore del campo.
    • Nome pubblico = ID cliente
    • Descrizione = inserisci l'ID cliente.
    • Seleziona la casella di controllo "Richiedi questo attributo"
    • Seleziona la casella di controllo Visualizza questo attributo.
    • Widget = casella di testo
    • Seleziona Salva per tornare alla pagina Attributi app del portale per gli sviluppatori.
  6. Seleziona Salva modifiche.
  7. Seleziona l'icona Home > Svuota tutte le cache dal menu Drupal.
    Potrebbe essere necessario svuotare la cache del browser prima che il nuovo campo venga visualizzato nel modulo.

Per aggiungere un campo facoltativo per consentire allo sviluppatore di specificare la piattaforma per l'app, imposta gli attributi del campo come:

  • Nome interno = same_platforms
  • Nome pubblico = piattaforme
  • Descrizione: specifica una o più piattaforme per l'app.
  • Deseleziona le caselle di controllo per Richiedi questo attributo
  • Seleziona la casella di controllo Visualizza questo attributo.
  • Widget = Elenco di caselle di controllo
  • Seleziona Salva per tornare alla pagina Attributi app del portale per gli sviluppatori.

Per riordinare gli attributi nel modulo:

  1. Accedi al portale come utente con privilegi di amministratore o per la creazione di contenuti.
  2. Seleziona Configuration > Dev Portal Settings > Dev Portal App Attributes (Configurazione > Impostazioni portale di sviluppo > Attributi app del portale di sviluppo) nel menu di amministrazione di Drupal.
  3. Seleziona il simbolo + sotto la colonna Nome e trascina la proprietà nella posizione in cui vuoi visualizzarla nel modulo.
  4. Salva le modifiche.