Creazione di flussi per un'API da zero

È possibile creare flussi per un'API (noti anche come flussi API ) in App Connect. La configurazione definita fornisce un'API che espone una o più operazioni. È possibile utilizzare queste operazioni per richiamare un endpoint e passare i dati tra questo e le applicazioni del flusso.

Prima di iniziare

  • Se si conoscono le applicazioni o le API importate di cui si ha bisogno, creare gli account nella pagina App Connect Applicazioni e API per i connettori che eseguono operazioni API contro le applicazioni o le API di destinazione. È possibile creare account anche quando si crea un flusso. Per ulteriori informazioni, vedere Connessione agli account.
  • Per utilizzare l 'authoring unificato per creare flussi API gestibili in API Connect assicurarsi di soddisfare i seguenti requisiti.
    • È necessario avere accesso a una API Connect capacità in IBM® webMethods Hybrid Integration. La API Connect può trovarsi nello stesso ambiente della propria capacità o in un ambiente diverso App Connect o in un ambiente diverso. In alternativa, è possibile utilizzare un'istanza di IBM API Connect Enterprise as a Service nella stessa regione dell'ambiente webMethods Hybrid Integration dell'ambiente. Per fornire un'istanza di prova di API Connect Enterprise as a Service dalla pagina iniziale App Connect dalla home page, fare clic su Gestisci flussi API utilizzando IBM API Connect.
    • L'istanza API Connect deve essere configurata con almeno un servizio DataPower API Gateway registrato.
    • L'istanza API Connect deve contenere almeno un'organizzazione di provider a cui si è autorizzati ad accedere. L'organizzazione provider deve includere un catalogo che contenga un'applicazione con un'organizzazione di consumatori proprietaria e un ID cliente.
    • È necessario abilitare l'authoring unificato per la propria istanza. Nella scheda Designer dell'editor del flusso API, fare clic sull'icona Modifica impostazioni gateway API Icona Modifica impostazioni gateway API, abilitare l'authoring unificato, quindi fare clic su Salva. (Se non si dispone di una funzionalità API Connect nell'ambiente webMethods Hybrid Integration o di un'istanza di API Connect Enterprise as a Service nella stessa regione dell'ambiente webMethods Hybrid Integration, l'icona Modifica impostazioni gateway API è disattivata)
      La funzione di authoring integrato è abilitata nelle impostazioni del gateway API.

Informazioni su questa attività

Quando si creano flussi per un'API, ogni singolo flusso è l'implementazione di un'operazione API che viene tipicamente richiamata dalle applicazioni mobili e web. (Esempi di operazioni sono "GET order" e "POST order") Il flusso per ogni operazione contiene una richiesta, azioni per una o più applicazioni o API importate e una risposta per l'operazione API. Il flusso può contenere anche nodi toolbox per l'elaborazione specializzata dei dati. La richiesta utilizza un modello definito dall'utente per richiedere la creazione, il recupero o la sostituzione di oggetti di dati nelle applicazioni. Quando la richiesta viene inviata, ogni applicazione o API di destinazione completa la propria azione. Il flusso restituisce quindi una risposta che conferma che le azioni sono state eseguite correttamente o restituisce i dati che erano stati richiesti.

La definizione dell'API comporta le seguenti fasi di alto livello.
  1. Si creano uno o più modelli che definiscono la struttura degli oggetti che si desidera creare o recuperare. È possibile creare fino a 10 modelli.
  2. Si possono scegliere le operazioni integrate di creazione, recupero, sostituzione o aggiornamento da completare con ciascun modello, oppure si possono definire operazioni personalizzate.
  3. Si configura un flusso per implementare ogni operazione e si aggiungono azioni per una o più applicazioni o API di destinazione. Si possono anche aggiungere al flusso le utilità del toolbox per elaborare i dati in ingresso o in uscita da queste applicazioni.
Unificazione dell'authoring:

Se si dispone di un'istanza di API Connect nello stesso ambiente o regione della propria istanza App Connect si può esporre l'API in entrambi i formati App Connect e API Connect. Questa funzione è nota come authoring unificato. L'authoring unificato è disattivato per impostazione predefinita.

Con l'authoring unificato, quando si crea e si avvia un flusso API in App Connect l'API viene aggiunta automaticamente a un Prodotto. Il prodotto viene quindi pubblicato in un catalogo fornito a un'organizzazione di fornitori in un'apposita sezione API Connect. Il prodotto diventa visibile anche nel API Connect Developer Portal se il sito è abilitato per il catalogo. Le preferenze di pubblicazione si basano sull'utente che ha effettuato l'accesso. App Connect scopre automaticamente le organizzazioni di provider in API Connect che l'utente ha accesso nello stesso ambiente o regione dell'istanza App Connect istanza. È possibile specificare le impostazioni per la pubblicazione dell'API a un'istanza preferita API Connect e a un'organizzazione di provider preferita. È inoltre possibile scegliere i target del catalogo e del gateway, il prodotto e il piano contenenti l'API pubblicata e un'applicazione di consumo.

È possibile lavorare con l'API in API Connect indipendentemente dall'API in App Connect. È inoltre possibile consultare il prodotto (e l'API) nel portale degli sviluppatori. Quando si interrompe l'API in App Connect il Prodotto (e l'API) nell'interfaccia utente di API Manager e nel sito del Portale sviluppatori vengono eliminati automaticamente. (Un utente che non ha accesso a API Connect può interrompere il flusso in App Connect. Tuttavia, l'API rimane pubblicata in API Connect.)

Se si ha accesso a una funzionalità di API Connect in webMethods Hybrid Integration, o a un'istanza di IBM API Connect Enterprise as a Service nella stessa regione della propria istanza di App Connect istanza, è possibile abilitare l'authoring unificato. Quando l'authoring unificato è abilitato e si crea e si avvia un flusso API, il flusso viene pubblicato automaticamente su API Connect. Se si avvia un flusso API senza specificare le preferenze di pubblicazione, l'API viene pubblicata sul Piano predefinito in un Prodotto generato automaticamente in un catalogo sandbox in qualsiasi istanza scoperta API Connect istanze scoperte.

È possibile utilizzare l'editor API in App Connect per creare un flusso API e per definire modelli e implementare operazioni per la propria API. È inoltre possibile configurare le impostazioni dei criteri, del gateway e del portale per controllare il comportamento dell'API quando viene pubblicata su API Connect dopo l'avvio del flusso. Le operazioni seguenti descrivono come creare il flusso API, configurare le preferenze di pubblicazione e accedere all'API pubblicata in API Connect.

Creazione del flusso API in App Connect

Procedura

Per creare un flusso API, completare i seguenti passaggi.

  1. Nella pagina iniziale di App Connect, fare clic su Crea flussi per un'API.
    In alternativa, vai alla pagina Design L'icona che rappresenta la pagina Design e fai clic su Crea > Flussi per un'API.
    L'editor API si apre con tre schede.
    Progettista
    Utilizzare la scheda Designer per creare modelli e operazioni per l'API.
    OpenAPI
    Utilizzare la scheda OpenAPI per visualizzare una rappresentazione dell'API in un formato conforme alla specifica OpenAPI 3.0.
    Gateway
    Se l'authoring unificato è abilitato, usare la scheda Gateway per vedere le impostazioni predefinite che il gateway può usare per chiamare le API pubblicate in API Connect. È inoltre possibile applicare criteri API aggiuntivi o configurare le impostazioni di gateway e portale per questa API.

    Se l'authoring unificato è disattivato, la scheda Gateway fornisce le istruzioni per attivarlo.

  2. Facoltativo: Per abilitare l'authoring unificato, accedere alla scheda Designer, fare clic su Modifica impostazioni gateway API Icona Modifica impostazioni gateway API, abilitare l'authoring unificato, quindi fare clic su Salva.
    Quando si attiva l'authoring unificato, è possibile vedere e modificare le preferenze per la pubblicazione del documento API. Queste preferenze sono descritte al punto 15.
  3. Inserire un nome che identifichi lo scopo del flusso.
    L'immagine mostra le tre schede dell'editor API e il nome del flusso è impostato su Customer API.

    Man mano che si procede con il flusso, App Connect salva automaticamente le modifiche. Se ci si allontana dal flusso, questo viene salvato come bozza di flusso da completare in un altro momento.

  4. Per creare un modello che definisce la struttura di un oggetto con cui si vuole lavorare, inserire un nome in Nome modello, quindi fare clic su Crea modello.
    Ad esempio, si potrebbe desiderare un oggetto cliente per il quale sia possibile creare, recuperare o aggiornare i record.
    Il pannello del modello presenta due schede.
    Proprietà
    Utilizzare la scheda Proprietà per definire la struttura del modello.
    Operazioni
    Usare la scheda Operazioni per definire il modo in cui l'API interagisce con il modello.
    Pannello del modello con le schede Proprietà e Operazioni
  5. Nella scheda Proprietà si definisce la struttura del modello configurando le proprietà.
    Nota: le proprietà hanno i seguenti requisiti e restrizioni.
    • Ogni nome di proprietà deve essere unico.
    • Il nome deve contenere solo lettere, numeri o il carattere di sottolineatura.
    • Gli spazi non sono ammessi nel nome, ma è possibile utilizzare un carattere di sottolineatura (_) per separare le parole.
    • Il nome deve iniziare con una lettera o un trattino basso.
    1. Per aggiungere la prima proprietà, inserire un nome e selezionare un tipo di dati per la proprietà.
      Per impostazione predefinita, la prima proprietà aggiunta ha l'opzione ID selezionata. Il flusso deve restituire la proprietà designata come ID del modello quando crea un oggetto. La proprietà ID deve essere inviata anche in una richiesta di aggiornamento o recupero di un oggetto, utilizzando il suo ID. Impostare un ID rispetto a una proprietà.
      Suggerimento: Per aggiungere una proprietà dalle applicazioni a cui si è connessi, si può anche fare clic su Seleziona proprietà dalle applicazioni. Selezionare l'account appropriato, selezionare una o più proprietà, quindi fare clic su Aggiungi proprietà.
      Schermata che mostra la finestra di dialogo per selezionare le proprietà dalle applicazioni. Il conteggio di HTTP collegato è selezionato e mostra un elenco di proprietà della richiesta.
    2. Per aggiungere altre proprietà, fare clic su Aggiungi proprietà.
      La schermata mostra le proprietà di un modello API Cliente. Le proprietà di tipo stringa vengono create per CustomerID, FirstName, LastName, e Email.
  6. Facoltativo: Per creare altri modelli, fare clic su Crea modello e aggiungere le proprietà per ogni nuovo modello.
    Per modificare il nome di un modello o cancellarlo, utilizzare l'opzione appropriata dal menu.
    La schermata mostra il menu a tendina per il modello, che contiene le opzioni Modifica informazioni modello e Cancella modello
  7. Per definire il modo in cui l'API interagisce con il modello, fare clic su Operazioni.
    • Per aggiungere una delle operazioni integrate, fare clic su Seleziona un'operazione da aggiungere, quindi scegliere un'operazione di Creazione, Recupero, Sostituzione o creazione da eseguire contro il modello.
      Schermata che mostra le opzioni del menu Selezionare un'operazione da aggiungere
    • Se si sceglie un'operazione che comporta un filtro, selezionare le proprietà del filtro appropriate. Per l'operazione Recupera nome_modello con filtro, è possibile anche attivare e configurare le impostazioni di paginazione per i risultati. La paginazione consente all'API di restituire una "pagina" di dati ogni volta che viene eseguita l'API. Il parametro limit indica il numero di record da restituire. Il parametro skip specifica il numero di record da saltare prima che il flusso inizi a restituire i record. Il parametro token è una stringa che l'API può usare per identificare il punto da cui iniziare a restituire i record.
      Per applicare i filtri, è necessario definire almeno due proprietà, compresa la proprietà ID del modello, perché la proprietà ID non può essere selezionata come filtro.
      Schermata che mostra le proprietà del filtro per l'operazione Recupera modello con filtro

      Per ulteriori informazioni, vedere Introduzione dei parametri di filtro per i flussi API in IBM App Connect e Configurazione della paginazione per l'operazione Retrieve with filter nei flussi API nella Comunità di integrazione IBM.

    • Per definire le proprie operazioni, fare clic su Seleziona un'operazione da aggiungere, quindi selezionare Aggiungi un'operazione personalizzata.
      Restrizione: Il parametro della query non può essere uguale all'ID del modello e il nome dell'operazione personalizzata non può essere una delle seguenti parole chiave.

      create, updateOrCreate, replaceOrCreate, findOrCreate, buildNearFilter, all, destroyAll, count, save, update, destroy, delete, remove, replaceById, updateAttributes, patchAttributes, upsertWithWhere, getChangeModel, getIdName, getSourceId, handleChangeError, rectifyChange, replaceById, replaceOrCreate, replicate, updateAll, upsert, upsertWithWhere, destroy, fillCustomChangeProperties, getId, isNewRecord, reload, replaceAttributes, save, setId, updateAttribute, updateAttributes

  8. Configurare un flusso che implementi l'operazione:
    1. Fare clic su Implementa flusso.
      Schermata che mostra il pulsante Implement flow (Implementa flusso) accanto al modello nella scheda Operations (Operazioni)
      L'editor di flusso contiene una struttura di base che contiene un nodo Richiesta, un nodo Risposta e uno spazio per aggiungere una o più applicazioni di destinazione, API importate o utilità del toolbox. La struttura dell'esempio del corpo della richiesta è costruita a partire dalle proprietà del modello, con alcuni dati di esempio.
      Schermata che mostra un flusso API nell'editor di flusso. Il flusso contiene un nodo Request e un nodo Response e mostra un esempio di contenuto per la richiesta
    2. Per aggiungere un'applicazione o un'API importata al flusso, fare clic su (+), selezionare un'applicazione o un'API, quindi selezionare un'azione appropriata.
      Assicurarsi che sia selezionato l'account corretto per App Connect per connettersi all'applicazione o all'API di destinazione. Se non ci sono account collegati, è possibile collegarsi a uno di essi seguendo le istruzioni riportate in Connessione agli account.
    3. Completare i campi dell'azione con i valori che si desidera passare all'applicazione o all'API di destinazione. È possibile specificare dati statici in testo semplice, oppure specificare dati dinamici aggiungendo mappature dai nodi precedenti del flusso. È anche possibile applicare funzioni (o espressioni JSONata) per trasformare i dati o utilizzare altri meccanismi integrati per definire valori personalizzati.

      Per inserire manualmente testo, mappature ed espressioni JSONata o per definire valori personalizzati, vedere Configurazione delle azioni.

      Per popolare automaticamente i campi per l'azione con mappature intelligenti suggerite, utilizzare Mapping Assist (vedere Semplificazione della mappatura e della trasformazione dei dati con suggerimenti basati sull'intelligenza artificiale ).
      La schermata mostra le mappature completate per un'azione di creazione di un contatto in Salesforce. Le proprietà ID conto, Cognome e Nome dell'azione Salesforce sono mappate rispettivamente alle proprietà CustomerID, LastName, e FirstName del modello API.
      Suggerimento: È possibile utilizzare dati di esempio generati automaticamente o personalizzati per testare le mappature man mano che vengono aggiunte. Per ulteriori informazioni, vedere Prova delle mappature con dati di esempio. Dopo aver completato i campi per l'azione, è possibile utilizzare dati di esempio per testare l'azione. Per testare l'azione, assicurarsi di utilizzare un account non di produzione, perché l'azione viene completata sull'applicazione di destinazione a cui si è connessi. Per ulteriori informazioni, vedere Prova delle azioni con dati di esempio.
    4. Opzionale: Aggiungere altre applicazioni o API importate.
    5. Opzionale: Utilizzare una o più utilità del toolbox supportate per fornire un'elaborazione specializzata.
      Ad esempio, aggiungere un nodo If per fornire un'elaborazione condizionale o un nodo For each per elaborare gli elementi recuperati. Per ulteriori informazioni, vedere Aggiunta di un'elaborazione speciale a un flusso (utilità del Toolbox).
    6. Fare clic sul nodo Response nel flusso per definire la risposta che viene restituita quando l'operazione viene completata con successo.
    7. Nella sezione Intestazione della risposta, specificare il codice di stato preferito per la risposta.

      Le operazioni di creazione restituiscono un codice di risposta 201 (record creato).
      Le operazioni di recupero restituiscono un codice di risposta 200 (record recuperato).
      Le operazioni di sostituzione o creazione restituiscono un codice di risposta 200 (record sostituito) o 201 (record creato).

    8. Nella sezione Corpo della risposta, definire quali campi vengono restituiti nel corpo della risposta, utilizzando testo, mappature da nodi precedenti del flusso o espressioni JSONata.
      La schermata mostra che la risposta è stata configurata mappando la proprietà CustomerID dell'operazione API con la proprietà Contact ID in Salesforce
      Suggerimento: Quando si crea un oggetto, di solito nel messaggio di risposta viene restituito solo l'ID dell'applicazione o dell'API di destinazione. Se si recupera un oggetto, il messaggio di risposta mostra tutti i campi richiesti dall'applicazione o dall'API di destinazione.

      Dopo aver configurato tutti i nodi del flusso, è possibile utilizzare dati di esempio generati automaticamente o personalizzati per testare il flusso prima di avviarlo. Assicuratevi di utilizzare account non di produzione quando testate il vostro flusso. Le azioni configurate nel flusso vengono completate sulle applicazioni di destinazione a cui si è connessi. Per ulteriori informazioni, vedere Prova di un flusso con dati di esempio.

    9. Fare clic su Fine per tornare al modello.
  9. Definire ulteriori operazioni per il modello e configurare un flusso che implementi ciascuna operazione.
    Schermata che mostra diverse operazioni per il modello, tra cui la creazione, il recupero per ID e la sostituzione o la creazione di modelli con filtro
  10. Definire le operazioni per eventuali modelli aggiuntivi e implementare i relativi flussi.
  11. Opzionale: è possibile aggiungere un flusso di cattura degli errori per gestire gli errori nel flusso API.
  12. Prima di testare o distribuire il flusso, correggere eventuali errori di convalida nel flusso.
    Per ulteriori informazioni, vedere Convalida del flusso.
  13. Facoltativo: Per visualizzare la definizione API del flusso, fare clic sulla scheda OpenAPI.
    La definizione dell'API è mostrata nella vista Form Icona del modulo, che è simile alla vista in cui si modificano le API in API Connect. I dettagli di questa scheda sono di sola lettura, ma vengono aggiornati automaticamente quando si modificano i modelli e le operazioni del flusso nell'editor API. La categoria Generale della vista modulo è espansa per impostazione predefinita. Sono disponibili anche le seguenti categorie. (Alcune sezioni di questa vista non sono attualmente applicabili o non visualizzano alcun dettaglio per l'API)
    La categoria Componenti mostra gli oggetti riutilizzabili che riguardano vari aspetti della definizione dell'API.
    • Schemi visualizza i dettagli di ogni modello e delle sue proprietà.
    • Le risposte non sono applicabili.
    • I parametri non sono applicabili.
    • Gli esempi non sono applicabili.
    • Gli organismi di richiesta non sono applicabili.
    • Le intestazioni non sono applicabili.
    • Schemi di sicurezza visualizza i dettagli dello schema di sicurezza della chiave API preconfigurata, utilizzata per fornire le credenziali (un ID client) quando si chiamano le operazioni API. Il nome dello schema di sicurezza è indicato come clientID con un tipo di apiKey, e un parametro X-IBM-Client-Id è usato per passare le credenziali nell'intestazione della richiesta dell'API.
    • I link non sono applicabili.
    Sezione Componenti della scheda OpenAPI
    La categoria Generale contiene le seguenti sezioni.
    • La sezione Info contiene il riepilogo dell'API. Questa sezione include il nome del flusso come titolo, un nome generato che si basa sul nome del flusso e che viene usato per identificare l'API, e una versione assegnata (in genere 0.0.1 ). I campi rimanenti sono vuoti.
    • La sezione Server mostra le definizioni dei server nell'API per la connessione a un server di destinazione. Quando si testa un'API, questa viene distribuita temporaneamente nel runtime di integrazione predefinito. Pertanto, il punto finale dell'API inizia con https://default-integration-runtime; ad esempio:
      https://default-integration-runtime-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
      Quando si distribuisce un'API, questa viene distribuita al runtime creato. Pertanto, l'endpoint dell'API inizia con il nome del runtime, ad esempio:
      https://my-custom-ir-https-ac0abcd2def.p-vir-d1.appconnect.ibmappdomain.cloud/Bookstore_API
      La sezione Server di un'API mostra un server URL per un'API sul runtime di integrazione predefinito.
    • Sicurezza visualizza i requisiti di sicurezza applicati all'API. Per impostazione predefinita, è configurato uno schema di sicurezza clientID del tipo apiKey .
    • La Documentazione esterna non è applicabile.
    • I tag non sono applicabili.
    Sezione generale della scheda OpenAPI
    La categoria Percorsi visualizza i percorsi per ciascuna delle operazioni definite nel flusso API. Ogni percorso comprende un verbo HTTP e un percorso URL (relativo) e definisce come viene esposta l'API. È possibile fare clic per espandere ciascun percorso URL nel riquadro di navigazione per approfondire l'argomento. Questa categoria contiene le seguenti sezioni.
    • I server non sono applicabili.
    • I parametri non sono applicabili.
    • Operazioni mostra i dettagli in base al tipo di operazione. Ad esempio, si possono vedere i tag (che corrispondono al nome del modello), i parametri di percorso o di query, oppure i codici di risposta e le descrizioni.
    Sezione Percorsi della scheda OpenAPI
    È possibile visualizzare il sorgente YAML di OpenAPI per la definizione dell'API nell'interfaccia utente, facendo clic su Source Icona della fonte. Anche questa vista è di sola lettura e il sorgente YAML è conforme alla specifica OpenAPI 3.0.
    Vista d'origine per una definizione di API
  14. Facoltativo: Se l'authoring unificato è abilitato, fare clic sulla scheda Gateway per visualizzare e configurare i criteri e le impostazioni di gateway e portale. Le impostazioni configurate qui influiscono sul comportamento dell'API pubblicata in API Connect ma non hanno effetto sull'API in esecuzione in App Connect.

    Se l'authoring unificato è disabilitato, andare al punto 16 per avviare il flusso.

    Politiche
    Utilizzare questa vista per vedere l'editor di assiemi e creare assiemi per personalizzare l'API. Un assembly è formato da elementi (come politiche o costrutti logici) che vengono applicati alle chiamate e alle risposte alle operazioni dell'API. L'editor di assiemi comprende una tavolozza che elenca gli elementi disponibili. Include anche una scheda delle proprietà a scorrimento che serve a configurare un elemento e un'area di disegno che serve a disporre e visualizzare gli elementi dell'assieme. Per ulteriori informazioni, vedere L'editor di assembly, Criteri API e costrutti logici e Gestione degli errori nell'assembly nella documentazione API Connect documentazione.
    Editor di assiemi nella vista Politiche
    Quando si apre per la prima volta la vista Policies, il canvas fornisce un singolo criterio Invoke per l'esecuzione dell'API. Il gateway può utilizzare questo criterio per chiamare l'API in esecuzione in App Connect. È possibile fare clic per aprire la scheda delle proprietà di questo criterio. Tuttavia, non è necessario modificare le impostazioni predefinite, che includono anche un nome utente e una password per l'autenticazione di base HTTP. La variabile app-connect-designer-url nel campo URL rappresenta l'indirizzo URL dell'istanza corrente App Connect a cui il gateway deve accedere. Questo URL è definito nella scheda Gateway, in Impostazioni gateway e portale > Proprietà.
    Nota: Non eliminare il criterio predefinito Invoke (intitolato Invoke flow), a meno che non si riesca a trovare un metodo alternativo per accedere all'endpoint App Connect endpoint URL per chiamare l'API. app-connect-designer-url definisce il punto finale URL.
    Richiamare le impostazioni predefinite dei criteri di flusso nella scheda delle proprietà
    È possibile aggiungere altri criteri o costrutti logici dalla tavolozza per soddisfare le proprie esigenze. Ad esempio, per limitare le chiamate all'API, è possibile trascinare un criterio Rate limit nella posizione corretta dell'assieme. È quindi possibile utilizzare la scheda delle proprietà per definire il numero massimo di chiamate consentite in un determinato periodo di tempo. Per ulteriori informazioni, vedere Limite di velocità nella documentazione di API Connect.
    Suggerimento: se un limite di velocità è definito nell'assieme, influisce sulle chiamate solo in quel punto dell'assieme. Se il piano consente di procedere con una chiamata, ma viene superato un limite rigido impostato sull'assieme, la chiamata viene interrotta nel punto del flusso di processo in cui è impostato il limite di velocità. Tutte le azioni che compaiono nel flusso di processo dell'assieme prima del completamento del criterio del limite di velocità. Vengono annullate solo le azioni che appaiono nel flusso dopo il criterio del limite di velocità.
    Politica di limitazione delle tariffe nell'area di lavoro dell'editor di assiemi
    Impostazioni gateway e portale
    Questo pannello consente di visualizzare le impostazioni generali di configurazione dell'API e di aggiornarne alcune. Per ulteriori informazioni, consultare la sezione Specificare le impostazioni del gateway e del portale nella documentazione API Connect documentazione.
    Sezione Impostazioni del gateway e del portale
    Suggerimento: La proprietà predefinita app-connect-designer-url (in Impostazioni gateway e portale > Proprietà ) definisce l'indirizzo URL dell'istanza corrente App Connect che il gateway utilizza per l'accesso. Non cancellare o modificare questa proprietà.
    Sezione Impostazioni del gateway e del portale
  15. Facoltativo: se è abilitato l'authoring unificato, configurare le preferenze di pubblicazione per API Connect

    Se l'authoring unificato è disabilitato, andare al punto 16 per avviare il flusso.

    È possibile configurare o aggiornare le preferenze di pubblicazione solo quando il flusso è fermo. Le preferenze di pubblicazione sono associate solo a quel flusso.

    Se si avvia un flusso API senza aver prima impostato le preferenze di pubblicazione per quel flusso, viene utilizzato l'ultimo set di preferenze utente salvate per un flusso. Se non sono state impostate preferenze in precedenza, l'API viene pubblicata sul Piano predefinito in un Prodotto generato automaticamente in un catalogo sandbox in una qualsiasi delle istanze scoperte API Connect istanze scoperte.

    1. Nella scheda Designer dell'editor API, fare clic sull'icona Modifica impostazioni gateway API Icona Modifica impostazioni gateway API.
      Posizione dell'icona Preferenze nell'editor API
      Si apre il pannello delle impostazioni del gateway API.
      Schermata del pannello delle impostazioni del gateway API
      Nota: è possibile disattivare l'authoring unificato in questo pannello se non si desidera pubblicare automaticamente il flusso API su API Connect. Non è possibile disattivare l'authoring unificato o aggiornare altre preferenze mentre il flusso è in esecuzione dopo l'avvio. È possibile visualizzare le preferenze selezionate in modalità di sola lettura, ma è necessario interrompere il flusso se si desidera aggiornare le preferenze. Quando si interrompe il flusso, l'API pubblicata viene cancellata. Dopo aver riavviato il flusso, l'API viene ripubblicata secondo le preferenze aggiornate.
    2. In Destinazione di staging e impostazioni di runtime, utilizzare i link di modifica per definire la destinazione di staging attraverso la quale è possibile pubblicare il prodotto (e l'API) e i servizi gateway che ospitano l'API pubblicata.
      Catalogo di destinazione

      Specificare il catalogo attraverso il quale si vuole pubblicare il Prodotto che contiene l'API. Il catalogo selezionato viene utilizzato come ambito per le altre impostazioni delle preferenze. I cataloghi API sono mostrati per le API Connect nello stesso ambiente in cui si trova la App Connect capacità. Per selezionare un catalogo dalla API Connect in un altro ambiente a cui si ha accesso, fare clic su Altri ambienti. Per scoprire i cataloghi API in un'istanza di API Connect Enterprise as a Service nella stessa regione della propria istanza webMethods Hybrid Integration istanza, passare alla scheda Altri ambienti e fare clic su Cerca esterno.

      Spazio di destinazione
      Se il catalogo selezionato è suddiviso in spazi, specificare lo spazio in cui si desidera pubblicare.
      Nota: se si è scelto di utilizzare il catalogo sandbox integrato, l'opzione Spazio di destinazione non viene visualizzata perché gli spazi non possono essere abilitati per questo catalogo. Se si sceglie un catalogo esistente non partizionato in spazi, l'opzione Spazio di destinazione non viene visualizzata.
      Servizi gateway di destinazione
      Specificare quali servizi del gateway forniscono la capacità di gestire il traffico in entrata per il prodotto e l'API pubblicati. In genere, solo i servizi Gateway scoperti con un tipo di Gateway datapower-api-gateway sono considerati compatibili.
      • Usa tutti i servizi gateway compatibili: Fare clic su questa opzione per utilizzare tutti i servizi Gateway compatibili rilevati.
      • Seleziona i servizi gateway compatibili: Fare clic su questa opzione per selezionare uno o più servizi gateway compatibili di propria scelta. (I tipi di gateway incompatibili sono disattivati)
      Impostazioni di esempio per un catalogo, uno spazio e un gateway
    3. In Impostazioni di consumo API, utilizzare i link di modifica per definire il modo in cui confezionare l'API per i consumatori e gestire l'uso dell'API.
      Prodotto di destinazione
      Specificare il Prodotto che contiene l'API.
      • Genera prodotto automatico: Fare clic su questa opzione per utilizzare un prodotto generato automaticamente. Il nome di questo prodotto è indicato come API title auto product nel pannello delle impostazioni del gateway API, dove API title rappresenta il nome del flusso. (Questo nome è diverso nella vostra API Connect come descritto più avanti)
      • Prodotto esistente: Fare clic su questa opzione per selezionare un prodotto esistente dal catalogo selezionato.
      Limite di frequenza del prodotto di destinazione
      Se si è scelto di pubblicare su un Prodotto generato automaticamente, configurare un limite di velocità per controllare le chiamate all'API. Questo limite tariffario viene applicato al Piano predefinito nel Prodotto autogenerato ed è condiviso da tutte le operazioni all'interno del Piano.
      • Illimitato: Fare clic su questa opzione per consentire chiamate illimitate.
      • Personalizzato: Fare clic su questa opzione per definire un numero specifico di chiamate in un periodo di tempo.

      Se è stato selezionato un Prodotto esistente, l'opzione Limite tariffa prodotto target è disattivata. Vengono invece applicati i limiti tariffari configurati nel prodotto e nel piano selezionati.

      Suggerimento: È inoltre possibile utilizzare la scheda Gateway nel flusso API per aggiungere un criterio Rate Limit in qualsiasi punto del flusso dell'assieme API per definire un limite di velocità più granulare nell'assieme API.
      Piano di destinazione

      Se si è selezionato un Prodotto esistente, scegliere un Piano associato a cui un'applicazione selezionata possa abbonarsi e consumare l'API.

      Se si è scelto di pubblicare su un Prodotto generato automaticamente, l'applicazione viene automaticamente abbonata al Piano predefinito di questo Prodotto e non è possibile modificare questa impostazione.

      Applicazione di test
      Selezionare un'applicazione che si desidera sottoscrivere al piano selezionato per consumare l'API.
      • Usa l'applicazione di test integrata: Selezionare questa opzione per utilizzare l'applicazione di test fornita in precedenza. Questa opzione è disponibile solo se si è scelto di utilizzare il catalogo sandbox.
      • Scegliere un'applicazione esistente: Selezionare questa opzione per selezionare un'applicazione esistente creata manualmente nel catalogo selezionato. (Se si dispone di un sito Developer Portal, l'applicazione viene registrata nel portale associato al catalogo selezionato)
      Organizzazione consumer di test

      L'organizzazione dei consumatori che possiede l'applicazione selezionata viene visualizzata qui per impostazione predefinita.

      Esempi di impostazioni per un prodotto, un piano e un'applicazione
    4. Fare clic su Salva per salvare le impostazioni.
      Le preferenze di pubblicazione vengono conservate per tutta la durata del flusso in App Connect. Le preferenze vengono mantenute quando si arresta e si riavvia l'API, oppure se si disattiva e si riattiva l'authoring unificato.
  16. È possibile eseguire il flusso per osservarne il comportamento.

Risultati

La tua API viene visualizzata come riquadro nella pagina Design. È possibile utilizzare il riquadro per gestire la propria API. Le opzioni disponibili per la gestione delle API dipendono dal piano e dallo stato delle API. Per ulteriori informazioni, consultare Gestione dei flussi durante lo sviluppo.

Cosa fare successivamente

  • È possibile testare il comportamento dell'API prima di distribuirla. Per ulteriori informazioni, vedere Test di un'API.
    Nota: se l'authoring unificato è abilitato e si avvia il flusso prima di aver impostato le preferenze di pubblicazione per quel flusso, viene utilizzato l'ultimo set di preferenze utente salvate per un flusso. Se non sono state impostate preferenze in precedenza, l'API viene pubblicata sul Piano predefinito in un Prodotto generato automaticamente in un catalogo sandbox in una qualsiasi delle istanze scoperte API Connect istanze scoperte. Pertanto, per controllare dove viene pubblicata l'API, è necessario assicurarsi di specificare le impostazioni preferite prima di avviare l'API.
    Quando si testa un'API, nell'editor API è disponibile la scheda Test.
    Pagina di riepilogo della scheda Test API
    La definizione YAML di OpenAPI 3.0 per il flusso API in esecuzione in App Connect viene utilizzata per pubblicare automaticamente l'API su un Prodotto e un Piano nel catalogo e nell'organizzazione di provider specificati nella propria istanza API Connect istanza. Se è stato configurato un portale per sviluppatori, il prodotto API diventa visibile anche lì.
    Nota: Se è abilitato l'authoring unificato, l'API viene aggiunta a un prodotto generato automaticamente o a una versione indipendente del prodotto esistente selezionato, in base alle preferenze dell'utente. Il Prodotto pubblicato contiene solo la vostra API.
  • Quando si è pronti a eseguire il flusso in un ambiente di produzione, lo si distribuisce. Per ulteriori informazioni, vedere Distribuzione delle integrazioni.

Accedere all'API pubblicata in API Connect

Informazioni su questa attività

Se l'authoring unificato è abilitato, quando l'API è in esecuzione, è possibile accedere alla propria istanza per visualizzare l'API pubblicata nell'API Manager e nel Developer Portal API Connect per visualizzare l'API pubblicata in API Manager e Developer Portal.
Suggerimento: se non si vede la propria App Connect API in API Connect e avete abilitato l'authoring integrato qualche tempo fa, disabilitate l'authoring integrato, salvate le modifiche e riabilitatelo.

Procedura

Per accedere all'API in API Connect completare i seguenti passaggi.

  1. Nell'istanza API Connect, aprire l'interfaccia utente di API Manager.
  2. Nel riquadro di navigazione, fare clic sull'icona Gestione Icona di gestione.
  3. Nella pagina Gestione, selezionare la sandbox o il catalogo definito dall'utente in cui si è scelto di pubblicare.
    Nella scheda Prodotti, si può vedere il Prodotto pubblicato che contiene l'API. Il titolo e il nome del prodotto derivano dal nome del flusso API di origine e includono anche un riferimento a App Connect. Se si è scelto di pubblicare su un prodotto generato automaticamente, la versione del prodotto è indicata come 0.0.1. Se si è scelto di pubblicare su una versione autonoma di un Prodotto esistente, la versione del Prodotto viene ereditata.
    • Se si è scelto di pubblicare su un prodotto generato automaticamente, il titolo del prodotto viene visualizzato come API_flow_name (Created by App Connect Designer), mentre il nome viene visualizzato come api-flow-name-created-by-app-connect-designer.
    • Se si è scelto di pubblicare su un prodotto esistente, il titolo del prodotto viene visualizzato come Product name - API_flow_name (Created by App Connect Designer), e il nome viene visualizzato come product-name-api-flow-name-created-by-app-connect-designer.
    API pubblicate nell'interfaccia utente di API Manager
  4. Opzionale: Per lavorare con l'API (in modo limitato), fare clic sull'icona delle opzioni Icona delle opzioni e selezionare l'opzione di menu appropriata.
    Ad esempio, è possibile selezionare Gestisci API per visualizzare gli endpoint di base dell'API, oppure visualizzare le sottoscrizioni. È inoltre possibile utilizzare la scheda Analytics per visualizzare le analisi delle chiamate API.
    Restrizione: L'API non può essere sviluppata ulteriormente in API Connect ed esiste nell'interfaccia utente di API Manager solo finché l'API corrispondente in App Connect è in esecuzione. Quando si interrompe l'API in App Connect il prodotto viene automaticamente eliminato dal catalogo.
  5. Facoltativo: se si ha accesso a un portale per sviluppatori abilitato per il catalogo specificato, utilizzare il portale URL (in Impostazioni catalogo in API Manager) per aprire il sito del portale per sviluppatori.
    Individuazione del portale URL dalle impostazioni del catalogo Sandbox nell'interfaccia utente di API Manager
    Dal Portale sviluppatori, fare clic su Prodotti API per esplorare il prodotto API pubblicato.
    Prodotto e API pubblicati nel portale degli sviluppatori
    È possibile fare clic sul nome del prodotto o sul nome dell'API per visualizzare i dettagli del piano o la definizione di OpenAPI dell'API, oppure per testare l'API.
    OpenAPI definizione dell'API nel Portale sviluppatori

    Per ulteriori informazioni, vedere Esplorare le API e i prodotti nel portale per sviluppatori nella documentazione API Connect documentazione.

    Limitazione: Il prodotto API esiste nel portale degli sviluppatori solo quando l'API corrispondente è in esecuzione App Connect è in esecuzione. Quando si interrompe l'API in App Connect il prodotto API viene automaticamente rimosso dal portale.