La consola posibilita que las llamadas a las APIs se hagan de manera más sencilla que con Postman. Para realizarlas, se habilitan una serie de campos que permiten personalizar cada llamada.
Los diferentes apartados de la llamada a través de la consola son:
– Service
– Authentication
– Headers
– URI Parameters
– Query Parameters
– Form Parameters
Service
Esta sección nos muestra el servicio que se va a llamar a través de la consola. Como ejemplo de esta guía, llamamos a la API Auto Loan, en concreto, al servicio Vehicles Details ( /vehicles/{vehicle-id}).
Debemos elegir el entorno en el que queremos realizar la llamada. Tal y como se explica en el apartado Consola, aconsejamos realizar la llamada en el entorno Sandbox para poder configurar la llamada con diferentes valores a los que vienen preestablecidos.
A continuación, elegimos la aplicación que usaremos para hacer la llamada. La herramienta nos mostrará las diferentes aplicaciones que hayamos creado para seleccionar una. La que elijamos debe tener disponible la API a la que queremos llamar ya que, de no ser así, obtendremos un error 403 como resultado de la llamada.
En la guía Primeros pasos te explicamos como hacer que una API esté disponible en tu aplicación.
Authentication
Aquí debemos elegir entre autenticación de 2 o 3 patas. Esta información la encontramos en la documentación técnica de la API, en la sección “Authentication”.
Por defecto, si no has hecho login, la consola siempre establece que la API requiere autenticación de 3 patas. En el caso de este ejemplo, la API Auto Loan requiere autenticación de 2 patas y por esto debemos modificar el valor.
Si has hecho login, el valor se configura automáticamente.
Headers
Establecemos las cabeceras HTTP de la llamada a la API. Los valores de estas cabeceras, tanto obligatorios como opcionales, se encuentran bajo el apartado “Header Parameters”. Además, se proporciona una breve explicación de los posibles valores.
En la consola vienen informadas por defecto las cabeceras obligatorias.
A través de los botones “+” y “x” se pueden añadir y eliminar cabeceras, respectivamente.
URI Parameters
Los parámetros URI son parámetros que pueden ser necesarios u opcionales en función del servicio al que se quiera llamar. En este ejemplo, la guía indica que hay un parámetro obligatorio que debemos informar con el que debemos informar el vehicle-id.
Para el caso que nos ocupa, usaremos el valor:
– vehicle-id: 34608
A través de los botones “+” y “x” se pueden añadir y eliminar parámetros, respectivamente.
Query Parameters
Los parámetros de la consulta se encargan de definir la consulta que estamos realizando, en este caso, el id del modelo del vehículo, el nombre del modelo, el año comercial de inicio (campo opcional) y el año final de comercialización. Toda esta información está disponible en la documentación de cada API.
Siguiendo con el ejemplo que estamos usando, introducimos los siguientes valores:
– endYear: 2020
– initYear: 2018
– model.name: GENERICO1
– model.id: 34
Esta consulta nos va a devolver toda la información relativa al vehículo solicitado.
Form Parameters
En esta sección se introducen los datos de la acción que se quiera realizar. En el caso de este ejemplo, no es necesario introducir ningún valor. Dejamos esta sección en blanco.
Ejecutar la consola
Después de haber configurado la llamada a la API a través de todas las secciones anteriores, hacemos clic en el botón “Send Action” para ejecutar la llamada.
El botón de “Clear” servirá para borrar todos los datos de la llamada. El botón de “Reset” reinicia todos los campos a los valores que se usan por defecto.
