Creazione di un prodotto bozza

Modifica online

Crea una bozza di prodotto per raccogliere una serie di API e piani in un'offerta che rendi disponibile per i tuoi sviluppatori. Un piano include delle impostazioni di limite di frequenza che possono essere applicate al piano nel suo insieme oppure specificate per ciascuna operazione in una API. Attraverso Prodotti e piani, devi dispone di un maggiore controllo su quali API gli sviluppatori possono accedere e sui termini di sottoscrizione.

Prima di iniziare

Definisci le tue API. Per ulteriori informazioni, consultare la sezione Creazione di una definizione API.
Suggerimento: oltre a utilizzare il metodo descritto in questa sezione, puoi anche creare un prodotto quando crei un'API. Se crei un'API utilizzando l'editor della riga di comando developer toolkit , un prodotto viene creato automaticamente per te. Puoi quindi modificare qualsiasi impostazione del prodotto aprendo il tuo nuovo prodotto nella pagina Prodotti di API Designer.

Informazioni su questa attività

Puoi completare questa attività utilizzando l'applicazione IU API Designer o utilizzando l'IU API Manager basata sul browser.

Quando si crea il prodotto per la prima volta, lo stato è bozza . Una volta terminata la configurazione del tuo prodotto bozza, lo prepari in un catalogo in modo che le API nel prodotto possano essere rese disponibili agli sviluppatori dell'applicazione.

Procedura

Per creare un prodotto, completare la seguente procedura:
  1. Nel riquadro di navigazione, fare clic su Icona di sviluppo nel riquadro di navigazione dell'interfaccia utente API Sviluppo, selezionare la scheda Prodotti, quindi fare clic su Aggiungi > Prodotto.
    Viene visualizzata la pagina Aggiungi prodotto .
  2. Selezionare Nuovo prodottoe fare clic su Avanti.
  3. Nella pagina Informazioni , completare la seguente procedura:
    1. Immettere il Titolo e la Versione del prodotto e, facoltativamente, una descrizione. Un Nome viene immesso automaticamente.
      Nota: il valore nel campo Nome è una singola stringa utilizzata per identificare il prodotto nei comandi CLI developer toolkit . Il Titolo viene utilizzato per la visualizzazione.

      Per visualizzare i comandi CLI per la gestione delle bozze dei prodotti, consultare la documentazione di riferimento della CLI del toolkit.

    2. Fare clic su Avanti.
  4. Nella pagina API , selezionare le API che si desidera includere nel prodotto. Per lo staging, è possibile includere solo le API il cui tipo di gateway corrisponde a quello del prodotto, oppure le API per le quali l'opzione "Enforced" è disabilitata. Le API per le quali l'opzione "Enforced" è disabilitata non vengono gestite su un API Connect gateway. Se si seleziona un'API non compatibile il cui tipo di gateway non corrisponde al tipo di gateway del prodotto, viene visualizzato un messaggio di avviso e non è possibile salvare le modifiche fino a quando non si deseleziona la selezione non compatibile. Per ulteriori informazioni sui tipi di gateway, consultare API Connect Tipi di gateway, Specificazione del tipo di gateway per un prodotto e Specificazione del tipo di gateway per una definizione API.
  5. Fare clic su Avanti.
  6. Nella pagina Piani , completare la seguente procedura:
    1. Facoltativo: modifica il titolo, la descrizione o le impostazioni relative al limite di frequenza per il piano predefinito.
    2. Facoltativo: per aggiungere altri piani, clicca su "Aggiungi", quindi scorri verso il basso e modifica le impostazioni del piano come desideri.
    3. Fare clic su Avanti.
  7. Per pubblicare automaticamente il prodotto nel catalogo sandbox dopo la creazione, selezionare Pubblica prodotto.
    Nota : l'opzione publish non è disponibile nella IU API Designer .
  8. Se è selezionato Pubblica prodotto , è possibile selezionare il servizio gateway in cui è pubblicato il prodotto. Per impostazione predefinita, il prodotto viene pubblicato in tutti i servizi gateway pertinenti.
  9. Nella sezione Visibilità , specificare gli utenti a cui si desidera che il prodotto sia visibile. Puoi scegliere Pubblico per rendere il prodotto visibile a tutti gli utenti, Autenticato per rendere il prodotto disponibile agli utenti che hanno eseguito correttamente l'autenticazione o Personalizzato per specificare le organizzazioni consumer e i gruppi di organizzazioni consumer per cui vuoi che il prodotto sia visibile.

    Se si seleziona Personalizzato, utilizzare il campo Tipo per aggiungere le organizzazioni per ricercare le organizzazioni consumer e i gruppi di organizzazioni consumer che possono sottoscrivere i piani nel prodotto. Per informazioni su come creare e gestire le organizzazioni consumer e i gruppi di organizzazioni consumer, consultare Amministrazione delle organizzazioni consumer.

    La visibilità può essere impostata anche a livello di catalogo o spazio. Per ulteriori informazioni, vedi Configurazione della visibilità del prodotto in un catalogo.

  10. Nella sezione Sottoscrivibilità , specifica gli utenti che possono sottoscrivere i piani nel prodotto. È possibile scegliere Autenticato per rendere i piani nel prodotto sottoscrivibili da utenti che hanno eseguito correttamente l'autenticazione oppure Personalizzato per specificare le organizzazioni consumer e i gruppi di organizzazioni consumer che possono sottoscrivere i piani nel prodotto.
    Se si seleziona Personalizzato, utilizzare il campo Tipo per aggiungere le organizzazioni per ricercare le organizzazioni consumer e i gruppi di organizzazioni consumer che possono sottoscrivere i piani nel prodotto. Se è stata selezionata la visibilità personalizzata, solo le organizzazioni consumer e i gruppi di organizzazioni consumer selezionati sono disponibili per l'aggiunta all'elenco di sottoscrivibilità personalizzato. Per informazioni su come creare e gestire le organizzazioni consumer e i gruppi di organizzazioni consumer, consultare Amministrazione delle organizzazioni consumer.
    Nota: se si seleziona la visibilità personalizzata o la sottoscrivibilità, le organizzazioni consumer e i gruppi di organizzazioni consumer da cui è possibile scegliere sono quelli nel catalogo Sandbox per il server di gestione e l'organizzazione provider a cui si è connessi. Se si desidera specificare le organizzazioni o i gruppi consumer o che si trovano in un altro catalogo o in uno spazio, pubblicare il prodotto in tale catalogo o spazio, quindi configurare la visibilità o la sottoscrivibilità; per i dettagli, consultare Modifica della disponibilità di un prodotto.

    Se si utilizza l'interfaccia utente di API Manager, i dettagli della connessione sono determinati dall' URL, che si apre, e dall'ID utente con cui si effettua il login. Se si utilizza l'interfaccia utente di API Designer, è necessario inserire i dati del server di gestione e l'ID utente nella finestra di accesso che si apre al primo avvio di API Designer; vedere Accesso ad API Designer.

    Se si sta lavorando offline in API Designer, è necessario immettere il nome esatto dell'organizzazione o del gruppo.

    Per ulteriori informazioni sulle organizzazioni consumer in un Catalogo, consultare Amministrazione delle organizzazioni consumer.

  11. Fare clic su Avanti per creare il prodotto.
    1. Per configurare ulteriormente il prodotto, fare clic su Modifica prodotto.
      Per ulteriori informazioni, vedere Modifica di una bozza di prodotto
    2. Se non vuoi configurare ulteriormente il tuo prodotto in questo momento, fai clic sul link Develop iniziale nella traccia di navigazione per tornare alla pagina Develop ; puoi quindi passare immediatamente a un'altra attività.
      Per informazioni su come configurare il prodotto in un secondo momento, vedere Modifica di una bozza di prodotto.

Risultati

Hai creato un prodotto bozza e specificato una serie di API e piani in un'offerta che puoi ora rendere disponibile ai tuoi sviluppatori.

Cosa fare successivamente

Preparare il prodotto in un Catalogo. Per ulteriori informazioni, vedere Messa in scena di una bozza di prodotto.