Richiamo di una API

Quando si seleziona un piano e si inizia a codificare l'applicazione, è necessario recuperare l'operazione URL per richiamare l'API.

Per recuperare l'operazione URL, completare i seguenti passaggi:

1. Fare clic su Prodotti API, quindi selezionare un prodotto.
2. Fai clic sull'API che vuoi utilizzare.
   Si apre la pagina di panoramica dell'API.
3. Selezionare l'operazione desiderata e copiare l'endpoint.
   Questa è l' URL a che l'applicazione chiama e la sua struttura è definita:

   Tipo di API	URL
   API REST	https://host/org/catalog/api/operation
   API SOAP	https://host/org/catalog/api per tutte le operazioni in WSDL.

   dove,

   • host è il nome host completamente qualificato del cluster del gateway.
   • org è il percorso di URL e della tua organizzazione.
   • catalog è il nome del catalogo.
   • api è il nome della tua API.
   • l'operazione è il percorso di URL e della tua operazione.
4. Prendere nota di tutti i parametri, del corpo della richiesta e del corpo della risposta. Codificare l'applicazione per creare le richieste previste e gestire le risposte previste.

A seconda dell'impostazione Identifica la tua applicazione utilizzando per l'API, potresti dover fornire un ID client o un ID client e un segreto client. Per effettuare questa operazione, completa la seguente procedura.

5. Per trovare l'ID client, completare la seguente procedura:
   1. Fare clic su App, quindi sul nome dell'applicazione che si desidera utilizzare.
   2. Selezionare la casella di controllo Mostra per ID cliente.
      Viene visualizzato l'ID client.
   3. Fornire l'ID client con il parametro di intestazione &client_id=
      Ad esempio, l' URL e utilizzato nell'API potrebbe essere:

      https://host/org/catalog/api/quote?loanAmount=20000

      ma quando lo chiami con un ID cliente di 1234, cambia l' URL :

      https://host/org/catalog/api/quote?loanAmount=20000&client_id=1234

      Nota: quando si registra un'applicazione, API Connect genera automaticamente un ID client. Tuttavia, se specifichi un ID client personalizzato, utilizzando la API CLI o REST, la lunghezza non deve superare i 512 byte, altrimenti il gateway rifiuterà la richiesta API e restituirà un errore 401 .
6. Il segreto client viene prodotto quando si registra un'applicazione. Fornire il segreto client con il parametro di query &client_secret=. Se non hai preso nota del segreto client quando hai registrato l'applicazione; per informazioni, vedi Gestione delle applicazioni.

L'ID cliente, o l'ID cliente e la password, possono essere registrati insieme all' URL. I server web di solito registrano l' URL e nei loro log di accesso, il che rivelerebbe il segreto del cliente. Se non vuoi esporre il tuo ID cliente o il tuo segreto nell' URL, completa i seguenti passaggi.

7. Per l'ID del client, impostare l'intestazione X-IBM-Client-Id, come parte del messaggio HTTP che l'applicazione invia quando chiama l'API.
   Un esempio di dichiarazione di conformità all' URL :

   curl --header "X-IBM-Client-Id: 1234" https://host/org/catalog/api/quote?loanAmount=20000

   Nota: quando si registra un'applicazione, API Connect genera automaticamente un ID client. Tuttavia, se specifichi un ID client personalizzato, utilizzando la API CLI o REST, la lunghezza non deve superare i 512 byte, altrimenti il gateway rifiuterà la richiesta API e restituirà un errore 401 .
8. Per il client secret, impostare l'intestazione, X-IBM-Client-Secret, come parte del messaggio di autorizzazione ( HTTP ) che l'applicazione invia quando chiama l'API.
   Ad esempio, l' URL e sarebbe:

   https://host/org/catalog/api/quote?loanAmount=20000

   e impostare le seguenti intestazioni dell' HTTP :

   X-IBM-Client-Id=1234
   X-IBM-Client-Secret=ABCD