Int. Man. 2 Prueba tu servicio

En “Prueba tu servicio” vas a comprobar que la respuesta del servicio es correcta. 

Si activaste la función “Usar distintas configuraciones para vista previa y publicar”, verás dos pestañas “Vista Previa” y “Publicar”. En cada una de estas pestañas, puedes probar tu servicio, con el endpoint que configuraste para cada uno de tus ambientes, simplemente selecciona la pestaña y realiza las pruebas.

Probando un servicio REST

Para las integraciones REST, este paso contiene 4 pestañas:

• Params

• Authentication

• Headers

• Body

Params

En “Params”, puedes poner a prueba el servicio con distintos parámetros, para comprobar las respuestas. Si no agregaste parámetros de entrada, verás dos columnas: “Key” y “Value”. 

Haz clic en el botón “Probar”. En la parte inferior verás “Respuesta”, donde se mostrarán los “Headers” y el “Body” de tu respuesta.

En “Headers” podrás ver todos los Headers que contiene la respuesta.

En “Body” podrás ver el Json de la respuesta.

En esta sección, opcionalmente puedes probar tu servicio con diferentes parámetros. Haz clic en “+Agregar parámetro”. A continuación escribe la clave y la key del parámetro con los que quieres probar la respuesta del servicio. Haz clic en “Probar”.

En la parte inferior verás “Respuesta”, donde se mostrarán los “Headers” y el “Body” de tu respuesta.

También verás tres datos:

• Status: Aquí verás el estado de la respuesta.

• Tiempo: Aquí verás el tiempo (en segundos) qué tomó obtener las respuestas.

• Tamaño: Aquí verás el peso total de la respuesta.

Si en “Configuración” agregaste parámetros de entrada, verás dos columnas más:”Parámetro” y “Valor”.

En la columna de “Parámetro”, verás el parámetro, o parámetros, que hayas agregado en “Configuración”.

En cada parámetro, asigna un valor en la columna “Valor”, para probar el servicio con estos valores como parámetros de entrada. Haz clic en el botón “Probar”.

En “Respuesta” podrás ver tu respuesta de acuerdo a los parámetros que indicaste. Puedes probar con distintos valores, para comprobar que la integración funcionará con los valores generados en el flujo. 

En “Headers” podrás ver todos los Headers que contiene la respuesta.

En “Body” podrás ver el Json de la respuesta obtenida en función de los valores que indicaste.

Los valores que coloques aquí, sólo son para probar el servicio, no afectan a las respuestas de las peticiones de un flujo en ejecución.

Authentication

Para conectar con éxito las integraciones SOAP, es necesario que cuentes con las credenciales de autenticación que te otorga el servicio web, para acceder a los datos. En Kosmos, puedes ingresar tus credenciales para conectarte con el servicio web.  El tipo de autenticación depende del servicio web. Los diferentes tipos de autenticación son:

No Auth

La autenticación “No Auth” no requiere credenciales para realizar las peticiones al servicio web. Es ideal para API abiertas.

API Key

Se trata de una cadena de caracteres que se utiliza para autenticar tu solicitud a la API. Es necesario proporcionar el API Key para que se le permita el acceso. Para usar esta autenticación debes ingresar:

• Key: Es el identificador único de la clave de la API que se proporciona para la autenticación. Esta clave se asigna al usuario que se registra para obtener acceso a los recursos protegidos.

• Value: Es el valor secreto asociado a la clave de la API que se proporciona. Este valor se utiliza para validar la identidad del usuario que intenta acceder a los recursos.

• Agregar a: Es la ubicación donde se deben incluir los datos de la clave de la API en la solicitud HTTP. Puede ser en el encabezado (Header) de la solicitud o como parámetros de consulta (Query Params) en la URL de la solicitud. 

Basic Auth

Es un método de autenticación que utiliza un nombre de usuario y una contraseña para permitir el acceso a un recurso o servicio. Para usar esta autenticación debes ingresar:

• Usuario

• Contraseña

OAuth 2.0

Es un protocolo de autorización que permite solicitar acceso a recursos o servicios en nombre de un usuario sin necesidad de compartir las credenciales del usuario. En este caso, el usuario autoriza a la aplicación a acceder a los recursos a través de un flujo de autorización. Para usar esta autenticación debes ingresar:

• Header prefix: Es un valor opcional que se agrega al inicio del encabezado de la solicitud. Por ejemplo, "Bearer " es un prefijo común utilizado con tokens de acceso.

• Access Token URL: Es la URL donde se puede solicitar un token de acceso. Es necesario que se proporcione una URL válida para poder realizar la autenticación.

• Grant Type: Este campo determina qué tipo de concesión de acceso se está utilizando. Las opciones son:

•  "Password Credentials" para autenticación de usuario y contraseña. 

• "Client Credentials" para autenticación de aplicaciones.

• "Custom" para tipos de autenticación personalizados.

• Client Authentication: Es la forma en que se autentica la aplicación que está intentando obtener acceso. 

• “Basic Auth Header” para solicitar acceso mediante el encabezado de autenticación básica 

• “Body” para solicitar acceso mediante la inclusión de las credenciales en el cuerpo de la solicitud

• Client ID: Es un identificador único para la aplicación que está intentando obtener acceso.

• Client Secret: Es una cadena secreta que se utiliza para autenticar la aplicación. Solo la aplicación y el servidor de autenticación deben conocer esta información.

• Scoope: Son los permisos que se están solicitando para acceder a los recursos protegidos. El servidor de autenticación puede conceder o denegar acceso en función de los permisos solicitados.

• Target: Este campo determina si el token de acceso debe enviarse en el encabezado o en los parámetros de la URL. Elige entre:

  • URL

  • Header

Bearer Token

El cliente obtiene un token de acceso después de que el usuario autoriza la solicitud. Este token de acceso se utiliza para autenticar todas las solicitudes subsiguientes. Sólo hay que copiar y pegar el Token.

Headers

Esta función es opcional, y depende del servicio web con el que estás conectando. Si tu servicio web, por cuestiones de seguridad te otorga Headers para realizar la petición, puedes ingresarlos en esta pestaña. Para agregar un Header, haz clic en “+Agregar Header”.

• En la columna Key, escribe el nombre de tu Header.

• En la columna Value, escribe el valor del Header.

Body

Esta función se utiliza cuando estás configurando una integración con método HTTP POST, y depende del servicio web con el que estás conectando. Si tu servicio web te otorga un Body para realizar la petición, puedes ingresarlo en esta pestaña.

Existen tres opciones para ingresar el body. Todo depende del servicio web.

1. raw: En esta opción se puede escribir información estructurada en formato JSON o XML, que será enviada al servicio web. Esta opción es útil para enviar información compleja o datos estructurados.

1. Para seleccionar raw, haz clic en el checkbox de “raw”

2. En el editor de código escribe el body que te brindó el servicio web.

2. x-www-form-urlencoded: En esta opción se envían datos en formato de formulario, donde los datos se envían como pares de claves y valores. Esta opción es útil cuando se envían datos simples, como nombres y direcciones de correo electrónico.

1. Para seleccionar esta opción, haz clic en el checkbox de “x-www-form-urlencoded”

2. Haz clic en “+ Agregar parámetro”.

3. Escribe el Key y su Value correspondiente.

4. Repite el proceso para todas las variables que quieras agregar.

3. form-data: En esta opción se pueden enviar tanto datos simples como archivos, como fotos o documentos. Esta opción es útil cuando se necesitan enviar archivos o información multimedia a un servicio web.

1. Para seleccionar esta opción, haz clic en el checkbox de “forma-data”.

2. Haz clic en “+ Agregar parámetro”.

3. Si el valor de tu variable es texto, despliega la lista de “Key” y elige “Text”.

1. En Value escribe el valor de la variable.

2. Repite el proceso para todas las variables.

4. Si el valor de tu variable es un archivo, despliega la lista de “Key” y elige “File”.

1. En Value escribe el valor del archivo.

1. Activa la opción “Usar archivo estático” para subir el mismo archivo cada vez que se haga la petición.

1. Haz clic en “Selecciona un archivo” y elige un archivo de tu equipo.

2. Desactiva la opción “Usar archivo estático” para subir documentos generados o cargados en el flujo. Para realizar esta acción, es indispensable haber creado parámetros de entrada de tipo documento.

1. Despliega la lista, y selecciona el parámetro de entrada de tipo documento.

5. Repite el proceso para todas las variables que quieras agregar.

Probando un servicio SOAP

Para los servicios SOAP, en la pestaña “Prueba tu servicio”, verás el XML en un editor de código. Tienes la posibilidad de editar el XML, si lo deseas.

Haz click en “Probar”. En la parte inferior verás “Respuesta”, donde se mostrará el XML de tu respuesta.

También verás tres datos:

• Status: Aquí verás el estado de la respuesta.

• Tiempo: Aquí verás el tiempo (en segundos) qué tomó obtener las respuestas.

• Tamaño: Aquí verás el peso total de la respuesta.

Si agregaste parámetros de entrada, verás dos columnas: “Parámetro” y “Valor”. En la columna “Parámetro”, verás el parámetro o parámetros, que agregaste en configuración.

En “Valor”, escribe un valor para cada parámetro y probar la respuesta en función de esos valores.