Invio delle API REST all' IBM API Connect e tramite l'interfaccia utente web

Utilizza l'interfaccia utente web per creare o aggiornare una definizione per una o più API REST distribuite in IBM® API Connect.

Per pubblicare una o più API REST su IBM API Connect, segui questi passaggi.

1. Nell'interfaccia utente Web, fare clic su Apri elenco di opzioni per il server di integrazione richiesto.
   • Se si stanno visualizzando tutti i server disponibili nella scheda Server , l'icona Apri elenco di opzioni viene visualizzata all'interno del riquadro per ciascun server di integrazione.
   • Se si sta visualizzando il contenuto di un server di integrazione nella scheda Contenuto , l'icona Apri elenco di opzioni viene visualizzata nella barra del titolo per il server di integrazione.
2. Fai clic su Share REST APIs to API Connect.
   Si aprirà la finestra di dialogo " Invia API REST a API Connect ", nella quale potrai definire la connessione al sistema IBM API Connect.
3. Seleziona la versione del sistema IBM API Connect a cui ti stai collegando.
   È possibile scegliere tra la versione 5, la versione 2018o la versione 10.
4. Inserisci i dettagli di connessione relativi al cluster o al server di gestione di IBM API Connect nei campi Host e Porta.
   • Per la versione 5, inserire i valori relativi all'host e alla porta del server di gestione o del cluster di IBM API Connect.
   • Per la versione 2018 o la versione 10, inserire i valori relativi all'host e alla porta del server di gestione o del cluster di IBM API Connect.
5. Inserisci le tue credenziali per accedere al sistema IBM API Connect.
   Nota:

   Se l'ambiente IBM API Connect è configurato con certificati autofirmati, oppure se la configurazione dei certificati non corrisponde al dominio dell'ambiente IBM API Connect, la prima fase del processo di invio delle API REST a API Connect non va a buon fine. Se si seleziona "Disabilita verifica certificato durante la connessione ", App Connect Enterprise ignora gli errori.

   • Per Versione 5, immettere nome utente e password.
   • Per Versione 2018 o Versione 10, immettere il nome utente e la password, insieme al realm, all'ID client e al segreto client.
     È possibile ottenere i valori relativi all'ID cliente e al segreto cliente registrando App Connect Enterprise come applicazione cliente autorizzata ad accedere all'ambiente IBM API Connect. Per registrare un'applicazione client dall'interfaccia a riga di comando (CLI) del toolkit IBM API Connect, procedere come segue:

     1. Creare un file denominato ace-registration.json, che verrà utilizzato come input per la creazione di un oggetto di registrazione. Aggiungi il seguente oggetto JSON come contenuto del file, dove clientID e clientSecret rappresentano i valori sicuri appropriati di tua scelta.

        {
          "name": "ace-registration",
          "client_id": "clientID", 
          "client_secret": "clientSecret",
          "client_type": "toolkit"
        }

        Esempio:

        {
          "name": "ace-registration",
          "client_id": "aceappid4321", 
          "client_secret": "aceapptopsecret",
          "client_type": "toolkit"
        }

     2. Se non disponi già di un'installazione locale del toolkit IBM API Connect, che fornisce i comandi CLI per IBM API Connect, scarica e installa il toolkit. Per ulteriori informazioni, consultare la sezione "Installazione del toolkit" nella documentazione di IBM API Connect.
     3. Da una finestra del prompt dei comandi, accedere al server di gestione di IBM API Connect utilizzando uno dei seguenti comandi CLI del toolkit. Assicurarsi di accedere come amministratore con l'autorità per creare le registrazioni.
        Accesso interattivo:

        apic-slim login

        (Ti verrà richiesto di inserire le tue credenziali IBM API Connect.)
        Accesso non interattivo

        apic-slim login --username userID --password userPassword --server mgmtServerEndpoint --realm realm

        Ad esempio:
        apic-slim login --username joebloggs --password mysecretpwd --server mycloudmanager.mydomain.com --realm admin/default-idp-1

        Per ulteriori informazioni su queste credenziali di accesso, consultare la sezione "Accesso a un server di gestione" nella documentazione di IBM API Connect.

     4. Crea una registrazione di tipo " IBM API Connect " per App Connect Enterprise eseguendo il seguente comando, specificando come input il ace-registration.json file creato in precedenza.

        apic-slim registrations:create --server mgmtServerEndpoint ace-registration.json

        Se si specifica un valore client_id esistente nel file ace-registration.json , il processo di registrazione genera in modalità non presidiata un nuovo ID client. Devi quindi verificare il valore client_id per la registrazione prima di specificarlo nella casella di dialogo Push REST APIs to API Connect . (Per i dettagli, consultare il passo successivo.)

     5. Confermare la registrazione emettendo il seguente comando:

        apic-slim registrations:get ace-registration --server mgmtServerEndpoint --output -

        Ad esempio:
        apic-slim registrations:get ace-registration --server mycloudmanager.mydomain.com --output -

        Dovresti vedere un output simile a questo:

        type: registration
        api_version: 2.0.0
        id: 6a45ed7e-d461-4ea7-89fa-f2a84b2f28ed
        name: ace-registration
        title: ace-registration
        state: enabled
        client_type: toolkit
        client_id: d2ddd06b-679b-4e84-a7db-c3a18aa3da52
        client_secret: '********'
        scopes:
          - 'cloud:view'
          - 'cloud:manage'
          - 'provider-org:view'
          - 'provider-org:manage'
          - 'org:view'
          - 'org:manage'
          - 'product-drafts:view'
          - 'product-drafts:edit'
          - 'api-drafts:view'
          - 'api-drafts:edit'
          - 'child:view'
          - 'child:create'
          - 'child:manage'
          - 'product:view'
          - 'product:stage'
          - 'product:manage'
          - 'approval:view'
          - 'approval:manage'
          - 'api-analytics:view'
          - 'api-analytics:manage'
          - 'consumer-org:view'
          - 'consumer-org:manage'
          - 'app:view:all'
          - 'app:manage:all'
          - 'my:view'
          - 'my:manage'
          - 'webhook:view'
        created_at: '2021-01-25T14:38:49.000Z'
        updated_at: '2021-01-25T14:38:49.000Z'
        url: >-
          https://mycloudmanager.mydomain.com/api/cloud/registrations/6a45ed7e-d461-4ea7-89fa-f2a84b2f28ed

        Se il valore client_id nell'output è diverso dal valore specificato nel file ace-registration.json , ciò indica che un nuovo ID client è stato generato dal processo di registrazione. Prendere nota di questo nuovo valore client_id perché ha la precedenza sul valore nel file ace-registration.json .

        Suggerimento: in alternativa, è possibile confermare la registrazione eseguendo questo comando, che scrive l'output in un file denominato ace-registration.yaml:

        apic-slim registrations:get ace-registration --server mgmtServerEndpoint

     6. Nella finestra di dialogo Push REST APIs to API Connect , immetti il valore client_id (dall'emissione apic-slim registrations:get ) nel campo ID client e immetti il valore client_secret dal file ace-registration.json nel campo del segreto client .

     Per ulteriori informazioni sulla creazione di un oggetto JSON per il file ace-registration.json e una registrazione client, vedi Ottenimento di un ID client e di un segreto nella documentazione di Open API Explorer.

6. Dopo aver immesso le credenziali, fare clic su Connetti a API Connect.
   Viene stabilita una connessione al server IBM API Connect e viene richiesto di specificare l'organizzazione, il prodotto e il catalogo di destinazione.
7. Seleziona l'organizzazione di destinazione in cui vuoi eseguire il push delle API REST.
   Il menu Organizzazione mostra un elenco delle organizzazioni presenti sul server IBM API Connect a cui hai accesso.
8. Specificare il nome del prodotto che si desidera aggiornare o creare, quindi fare clic su Continua.
   È possibile specificare un prodotto esistente oppure è possibile creare un nuovo prodotto. Specificare il titolo, il nome e la versione del prodotto. Se si desidera preparare il prodotto, specificare il nome del catalogo in cui si desidera che venga preparato.
   Sono elencate le API REST disponibili.
9. Seleziona le API REST che desideri inviare a IBM API Connect e aggiungere al prodotto, quindi fai clic su Continua.
   È possibile specificare l'endpoint che IBM API Connect utilizza per richiamare l'API REST ospitata su App Connect Enterprise.
10. Scegli se sovrascrivere il nome host e il numero di porta utilizzati da IBM API Connect per richiamare le API inviate, oppure se consentire a IBM API Connect di richiamare direttamente le API.
    Se si sceglie di ignorare il nome host e il numero di porta, è possibile specificare i dettagli del proxy HTTP, i dettagli del proxy HTTPS o entrambi.

    • Per completare la procedura di invio delle API REST a IBM API Connect tramite l'interfaccia utente web, fare clic su "Invia API".
    • Facoltativamente, è possibile copiare le proprietà impostate tramite l'interfaccia utente web negli appunti, in formato comando, facendo clic su Copia comando. È quindi possibile utilizzare questo output per modificare ed eseguire il mqsipushapis comando che invia le API REST a IBM API Connect. Per ulteriori informazioni, consultare la sezione "Invio di API REST a IBM API Connect tramite il comando mqsipushapis".
11. È possibile visualizzare lo stato di avanzamento man mano che le API REST selezionate vengono inviate a IBM API Connect.
    • Se sul server IBM API Connect è già presente una definizione API, questa verrà sostituita dalla definizione della tua API REST. Se non esiste alcuna definizione API sul server, viene creata una nuova definizione API per l'API REST.
    • Se il prodotto specificato esiste, viene aggiornato. Se il prodotto specificato non esiste, viene creato un nuovo prodotto.
    • Se viene selezionato un catalogo, il prodotto viene preparato nel catalogo.
12. Fare clic su singole attività per visualizzare una suddivisione dettagliata dell'avanzamento di ciascuna attività.
    Una volta che le API REST sono state pubblicate su IBM API Connect, chiudi la procedura guidata facendo clic su "Fatto".