Llamada a una API

Cuando haya seleccionado un Plan y comience a codificar su aplicación, deberá recuperar la operación URL para llamar a la API.

Para recuperar la operación URL, siga estos pasos:

1. Pulse Productos de APIy, a continuación, seleccione un producto.
2. Pulse la API con la que desea trabajar.
   Se abre la página de resumen de la API.
3. Seleccione la operación que necesite y, a continuación, copie el punto final.
   Se trata de la dirección URL a la que llama la aplicación y cuya estructura está definida:

   Tipo de API	URL
   API REST	https://host/org/catalog/api/operation
   API SOAP	https://host/org/catalog/api para todas las operaciones en el WSDL.

   Donde:

   • host es el nombre de host completo de su clúster de puerta de enlace.
   • org es la ruta URL de su organización.
   • catalog es el nombre de su catálogo.
   • api es el nombre de la API.
   • es la ruta URL de su operación.
4. Tome nota de los parámetros, el cuerpo de la solicitud y el cuerpo de la respuesta. Codifique la aplicación para crear las solicitudes esperadas y manejar las respuestas esperadas.

En función del valor Identificar la aplicación utilizando para la API, es posible que tenga que proporcionar un ID de cliente o un ID de cliente y un secreto de cliente. Para ello, siga los pasos siguientes.

5. Para buscar el ID de cliente, realice los pasos siguientes:
   1. Pulse Aplicacionesy, a continuación, pulse el nombre de aplicación con el que desea trabajar.
   2. Seleccione la casilla Mostrar ID de cliente.
      Se visualiza el ID de cliente.
   3. Proporcione el ID de cliente con el parámetro de cabecera &client_id=
      Por ejemplo, el URL utilizado en la API podría ser:

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

      pero cuando lo llames con un ID de cliente de 1234, cambia el URL a:

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

      Nota: API Connect genera automáticamente un ID de cliente al registrar una aplicación. Sin embargo, si especifica un ID de cliente personalizado, utilizando la CLI o la API REST, la longitud no debe superar los 512 bytes, de lo contrario, la pasarela rechazará la solicitud de API y devolverá un error 401 .
6. El secreto de cliente se genera cuando se registra una aplicación. Proporcione el secreto de cliente con el parámetro de consulta &client_secret=. Si no ha anotado el secreto de cliente al registrar la aplicación, debe restablecerla; para obtener información, consulte Gestión de aplicaciones.

El ID de cliente, o el ID de cliente y el secreto pueden registrarse junto con la dirección URL. Los servidores web suelen registrar la dirección URL en sus registros de acceso, lo que delataría el secreto del cliente. Si no quieres exponer tu ID de cliente o secreto en URL, completa los siguientes pasos.

7. Para el ID de cliente, establezca el encabezado X-IBM-Client-Id, como parte del mensaje HTTP que la aplicación envía cuando llama a la API.
   Un ejemplo de declaración URL podría ser:

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

   Nota: API Connect genera automáticamente un ID de cliente al registrar una aplicación. Sin embargo, si especifica un ID de cliente personalizado, utilizando la CLI o la API REST, la longitud no debe superar los 512 bytes, de lo contrario, la pasarela rechazará la solicitud de API y devolverá un error 401 .
8. Para el secreto de cliente, establezca el encabezado, X-IBM-Client-Secret, como parte del mensaje HTTP que la aplicación envía cuando llama a la API.
   Por ejemplo, el URL sería:

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

   y configure las siguientes cabeceras HTTP :

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