Funciones API

Acción API

La funcionalidad API proporciona una interfaz gráfica de usuario para probar API de manera similar a Postman. Esta acción incluye los siguientes campos:

• Resquest: Selector que permite elegir el método a utilizar
  • GET: Obtiene información.
  • POST: Agrega información.
  • PUT: Reemplaza o edita la información.
  • PATCH: Actualiza información.
  • DELETE: Elimina o borra información.
• Enter request URL: Ingresa la URL de la API a utilizar.
• Botón TEST: Permite ejecutar la URL y realizar la prueba.
• Response variable name: Ingresa el nombre de la variable donde se almacenará la información extraída del campo Test response.
• Test response: Muestra el resultado de la prueba, es la respuesta al seleccionar el botón TEST.
• Botón con icono de eliminar: Se encuentra solo en las ventanas de Params y Headers y permite eliminar una fila.
• Botón con icono de agregar: Se encuentra solo en las ventanas de Params y Headers y permite agregar una fila.

Además, la funcionalidad API contiene las siguientes ventanas:

• Ventana de Params: Permite realizar consultas en los datos de la API mediante el uso de pares de nombre y valor.

• Ventana de Authorization: Permite configurar los datos de acceso. La autenticación implica confirmar la identidad del cliente que envía una solicitud, mientras que la autorización implica confirmar que el cliente tiene permiso para llevar a cabo la operación del punto final.

• Ventana de Headers: Algunas API requieren el envío de encabezados específicos junto con las solicitudes, generalmente para proporcionar más metadatos sobre la operación que se está realizando. Esta ventana permite configurar los encabezados mediante el uso de pares de nombre y valor.

• Ventana de Body: Permite especificar los datos que se deben enviar con una solicitud, ya sea para agregar o actualizar datos estructurados.

• Ventana de Certificate: La capacidad de almacenar certificados en formato JKS (Java KeyStore) en la funcionalidad API ofrece la posibilidad de utilizar estos certificados en el lado del cliente al realizar solicitudes seguras. JKS es un formato de almacén de claves específico de Java utilizado para almacenar claves privadas y certificados en un contenedor seguro. Esto es esencial en entornos donde se requiere autenticación y seguridad adicional para las comunicaciones mediante certificados SSL/TLS. El hecho de poder gestionar estos certificados a través de la interfaz proporciona flexibilidad y seguridad en la implementación de servicios API.

Acción Json

La funcionalidad Json facilita la tarea de ingresar texto en formato JSON, permitiendo especificar si se trata de un objeto o una lista. Esta acción incluye los siguientes campos:

• Json Object: Al seleccionar esta opción, indica que el JSON a escribir es un objeto.
• Json list: Al seleccionar esta opción, indica que el JSON a escribir es una lista.
• List name: Este campo se activa después de seleccionar la casilla Json List, permitiendo crear una variable para almacenar la lista.
• JSON text (Variables is allowed): Campo donde se ingresa el texto tipo JSON, con la capacidad de incluir variables.

Acción Json-Verify

La funcionalidad JSON-Verify proporciona una manera de verificar que un texto en formato JSON contiene un atributo específico. Esta acción incluye los siguientes campos:

• Json: Se ingresa la variable que contiene el JSON o el texto JSON directamente.
• Attribute: Se ingresa el nombre del atributo que se desea verificar.
• Format: Selector que indica el formato del atributo a verificar.
• Value(Optional): Ingresa el valor que se espera para el atributo. Su uso es opcional.
• Checkbox Required: Se selecciona si el atributo es requerido.
• Checkbox Null allowed: Se selecciona si el dato puede ser nulo o vacío.
• Botón con icono de Eliminar: Elimina el atributo que se está .verificando, incluyendo los campos Attribute, Format, Value (Optional), checkbox Required y checkbox Null Allowed.
• Botón Add Atribute: Agrega un nuevo atributo para verificar, incluyendo los campos Attribute, Format, Value (Optional), checkbox Required, checkbox Null Allowed y un botón con icono de Eliminar.