Configurazione della registrazione delle app

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

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

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

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

Per impostazione predefinita, lo sviluppatore deve solo specificare 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 sulla procedura di registrazione delle app. Ad esempio, puoi configurare:

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

Questo argomento descrive come configurare la procedura di registrazione dell'app per il tuo portale. Tuttavia, questo argomento non descrive come creare prodotti API. Per saperne di più, consulta:

• Creare prodotti API
• Utilizzare l'API di gestione di Edge per pubblicare le API

Puoi configurare il portale in modo che gli sviluppatori non possano creare, eliminare o modificare le app in base al ruolo assegnato. Ad esempio, puoi configurare il portale in modo da creare una singola app predefinita per tutti gli sviluppatori al momento della registrazione. Poi, consente solo ad alcuni sviluppatori di aggiungere nuove app, eventualmente in base a una struttura di tariffe o ad altre caratteristiche dello sviluppatore. Utilizza i ruoli e le autorizzazioni per controllare quali sviluppatori possono creare, eliminare e modificare le app. Per saperne di più, vedi Aggiungere e gestire gli account utente.

Specifica i prodotti API disponibili sul portale

Esistono due modi per specificare i prodotti API disponibili quando un sviluppatore accede al portale:

• Specificare il livello di accesso durante la creazione di un prodotto API
• Limitare l'accesso a un prodotto API in base ai ruoli

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

Quando crei un prodotto API, specifica 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 sviluppatori Drupal 7, consulta Livello di accesso.

Limitare l'accesso a un prodotto API in base ai ruoli

Se attivi il modulo Drupal Accesso ai ruoli dei prodotti 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 tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Esamina i ruoli del portale per sviluppatori e le assegnazioni utente:
   • Seleziona Persone > Autorizzazioni > Ruoli nel menu di amministrazione di Drupal e aggiungi o modifica i ruoli e le autorizzazioni degli sviluppatori, in base alle esigenze.
   • Seleziona Persone nel menu di amministrazione di Drupal e modifica le assegnazioni di utenti e ruoli, se necessario.
3. Seleziona Configurazione > Dev Portal > Accesso ai ruoli dei prodotti API nel menu di amministrazione di Drupal.
4. Seleziona i ruoli che devono poter accedere a ogni prodotto API.
5. Fai clic su Salva configurazione.

Configurazione della modalità di associazione da parte di uno sviluppatore dei 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:

A seconda di come configuri il 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 assegnato a tutte le app.

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

• Non associare le app a nessun 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 obbligarla.
• Richiedere la selezione di un singolo prodotto API.
• Consenti la selezione di più prodotti API, ma non richiedono alcun prodotto.
• Consenti la selezione di più prodotti API e richiedono 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, mentre i pulsanti di opzione vengono visualizzati quando lo sviluppatore può selezionare un solo prodotto API.

Per impostare l'opzione di selezione dei prodotti API:

1. Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Seleziona Configurazione > Impostazioni del portale per sviluppatori > Impostazioni dell'applicazione nel menu di amministrazione di Drupal.
3. Nella pagina Impostazioni applicazione, espandi l'area Impostazioni prodotto API.
4. In Gestione dei 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 dei prodotti 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 tuo prodotto API utilizza "OAuth a tre token" (tipo di concessione del codice di autorizzazione), gli sviluppatori devono specificare un URL di callback quando registrano le loro app. L'URL di callback specifica in genere 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. Inoltre, il parametro redirect_uri deve corrispondere a quello registrato. Per ulteriori informazioni, consulta Implementare il tipo di autorizzazione con codice di autorizzazione.

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

1. Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Seleziona Configurazione > Impostazioni del portale per sviluppatori > Attributi dell'applicazione nel menu di amministrazione di Drupal.
3. Nella pagina Impostazioni applicazione, espandi l'area Impostazioni URL di callback.
4. In Gestione URL 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 per sviluppatori.
   • L'URL di callback non è obbligatorio né visualizzato.
5. Salva la configurazione.

Visualizzazione di dati e analisi per l'utilizzo delle app

Il portale può mostrare informazioni analitiche sull'utilizzo delle app. Se la visualizzazione dei dati e delle analisi è attivata, gli sviluppatori di app possono visualizzare 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 di risposta massimo
• Tempo di risposta minimo
• Numero di messaggi
• Numero errori

Per attivare gli analytics sul portale:

1. Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Seleziona Configurazione > Dev Portal > Impostazioni applicazione nel menu di amministrazione di Drupal.
3. Nella pagina Impostazioni applicazione, espandi l'area Impostazioni di rendimento app.
4. Seleziona la casella di controllo Mostra la scheda Dati e analisi app per sviluppatori.
5. Seleziona Test o Produzione per Ambiente per eseguire query sui dati di analisi. Per un portale disponibile al pubblico, in genere viene selezionata l'opzione 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 collegamento 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 la registra, il portale restituisce allo sviluppatore la chiave API per l'app. Lo sviluppatore utilizza poi questa chiave API per accedere ai proxy API forniti in bundle dal prodotto API associato all'app.

Puoi controllare la procedura di approvazione delle chiavi per ogni prodotto API quando lo crei:

La procedura di approvazione può essere:

• Automatica: una chiave API approvata viene restituita dal portale per il prodotto API quando lo sviluppatore registra l'app. In un secondo momento puoi revocare una chiave approvata automaticamente.
• Manuale: una chiave API viene restituita dal portale 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 nell'API o nell'interfaccia utente di gestione di Edge prima che possa essere utilizzata dallo sviluppatore per accedere al prodotto API. In un secondo momento puoi revocare una chiave approvata manualmente.

Per ulteriori informazioni, consulta Creare prodotti 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, in attesa dell'approvazione definitiva 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, un sviluppatore seleziona il nome dell'app nella pagina Le mie app e poi il link Prodotti:

In questo esempio, il prodotto API Premium Weather utilizza l'approvazione manuale ed è in attesa dell'approvazione della chiave da parte di un amministratore. Il prodotto API senza costi utilizza l'approvazione automatica e l'utilizzo della chiave per accedervi è stato approvato.

Per approvare o revocare manualmente una chiave:

1. Accedi all'interfaccia utente di gestione di Edge come utente con i privilegi di amministrazione per la tua organizzazione.
2. Seleziona Piattaforma API nel menu a discesa nell'angolo in alto a destra.
3. Seleziona Pubblica > App per sviluppatori per aprire l'elenco di app per sviluppatori.
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 per revocare l'accesso.
     

     

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

Controllo della memorizzazione nella cache di app e prodotti API

Le informazioni sui prodotti API e sulle app per sviluppatori vengono archiviate in remoto dal portale su Apigee Edge. Ciò significa che le modifiche ai prodotti e alle app dell'API possono essere eseguite dall'API o dall'interfaccia utente di Edge, senza passare per 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 di Edge, puoi attivare manualmente un aggiornamento della cache del portale, aggiornare le cache automaticamente quando viene eseguito il cron job del portale o entrambe le operazioni. Ad esempio, se configuri il job cron in modo che venga eseguito di frequente, ad esempio ogni 5 o 10 minuti, potresti non volere l'overhead dell'aggiornamento così frequente dei prodotti API e delle cache delle app per sviluppatori. In questo caso, puoi attivare l'aggiornamento della cache manualmente. Tuttavia, se il job cron 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 ricostruire le cache del prodotto API e dell'app per sviluppatori ogni volta che viene eseguito il programma cron.

Per specificare se ricostruire o meno le cache del prodotto API e delle app sviluppatore ogni volta che viene eseguito cron:

1. Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Nel menu Drupal, seleziona Configurazione > Impostazioni del portale per sviluppatori > Impostazioni applicazione.
3. Seleziona o deseleziona Ricompila le cache dell'app per sviluppatori e dei prodotti API ogni volta che viene eseguito cron.
4. Salva le impostazioni.

Per aggiornare manualmente le cache:

1. Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Nel menu di 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, il portale mostra il modulo predefinito:

In qualità di fornitore di API, ti consigliamo di modificare questo modulo per chiedere allo sviluppatore di fornire informazioni aggiuntive, ad esempio un ID cliente, la piattaforma di destinazione dell'app o altre informazioni. Il portale ti consente di aggiungere nuovi campi a questo modulo. Questi campi possono essere:

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

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, i valori dei campi vengono caricati automaticamente su 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 di Edge per accedere a questi campi da uno script.

Ad esempio, per visualizzare i nuovi campi del modulo nell'interfaccia utente di gestione di Edge, vai a Pubblica > App per sviluppatori e seleziona il nome dell'app. I nuovi valori di campo 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 per l'app nella pagina Le mie app.

Le procedure riportate di seguito descrivono come configurare i moduli di creazione delle app utilizzando l'interfaccia amministratore. Uno sviluppatore Drupal può eseguire ulteriori personalizzazioni, ad esempio la modifica della pagina "Le mie app", utilizzando hook personalizzati. Per scoprire di più su come modificare i comportamenti tramite codice, consulta gli esempi di API per 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 tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Assicurati che il modulo Gestione degli attributi delle app DevConnect sia attivo.
3. Seleziona Configurazione > Impostazioni del portale per gli sviluppatori > Attributi dell'app del portale per gli sviluppatori 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. Si tratta del nome della variabile utilizzata per memorizzare il valore del campo.
   • Nome pubblico = ID cliente
   • Descrizione: inserisci il tuo ID cliente.
   • Seleziona la casella di controllo per Richiedi questo attributo
   • Seleziona la casella di controllo Mostra questo attributo.
   • Widget = casella di testo
   • Seleziona Salva per tornare alla pagina Attributi app del portale per sviluppatori.
6. Seleziona Salva modifiche.
7. Seleziona l'icona Home > Svuota tutte le cache dal menu di Drupal.
   Potresti dover svuotare la cache del browser prima che il nuovo campo venga visualizzato nel modulo.

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

• Nome interno = intended_platforms
• Nome pubblico = Piattaforme
• Descrizione = specifica una o più piattaforme per la tua app.
• Deseleziona le caselle di controllo per Richiedi questo attributo
• Seleziona la casella di controllo per Mostra questo attributo.
• Widget = Elenco di caselle di controllo
• Seleziona Salva per tornare alla pagina Attributi app del portale per sviluppatori.

Per riordinare gli attributi nel modulo:

1. Accedi al tuo portale come utente con privilegi amministrativi o di creazione di contenuti.
2. Seleziona Configurazione > Impostazioni del portale per gli sviluppatori > Attributi dell'app del portale per gli sviluppatori nel menu di amministrazione di Drupal.
3. Seleziona il segno Più + nella colonna Nome e trascina la proprietà nella posizione in cui vuoi visualizzarla nel modulo.
4. Salva le modifiche.