Skip to main content

Adaptador API/Servicios Web

English

Introducción

A través del Adaptador API/Servicios Web, TAST se conecta con los servicios API REST que están disponibles en un punto final y los utiliza para realizar pruebas. Este Adaptador tiene un importante compañero llamado Web Services Mapping Assistant con una interfaz de usuario más detallada y compleja para ayudar a la creación de mensajes TAST y mapeos. 

Este Adaptador es utilizado para ejecutar pruebas de Servicios Web: REST, SOAP y otros. El Adaptador API/Servicios Web puede realizar todo tipo de llamadas y realizar comprobaciones sobre estas. Es posible realizar pruebas individuales con este adaptador o pruebas de extremo a extremo conectando con otros adaptadores.

Parámetros de Inicialización

En la configuración del Adaptador API/Webservice debemos incluir todos los datos que consideremos descriptivos del servicio en general y que se aplican a todas sus peticiones. Así el usuario no tendrá que indicarlo en cada mensaje del diagrama. Son los siguientes: 

  • EndPoint: especifica la URL que es común a todas las peticiones sobre ese servicio web.
  • Keep/Session: si marcamos esta casilla de verificación la sesión seguirá activa durante las diferentes llamadas o peticiones, y añadirá las cookies que reciba en las respuestas a las peticiones que realice.
  • IsSecure: indica si las peticiones al servicio se enviaron a través del protocolo http o https..
  • Headers(Opt.): permite agregar encabezados a todas las solicitudes que se envían al servicio.
  • Service-Charset: es el conjunto de caracteres que se utilizaran en el servicio HTTP. El Service Charset el más común es UTF-8. 

Las palabras y oraciones en el texto se crean a partir de caracteres. Una codificación de caracteres proporciona una clave para desbloquear (es decir, descifrar) el código. Así, el conjunto de caracteres es la información de codificación, es decir, el conjunto de asignaciones entre los bytes del ordenador y los caracteres del conjunto de caracteres. Sin la clave, los datos parecen basura.  El Service Charset Cp1047 es usado por defecto.

  • Authentication Type: permite seleccionar el tipo de autenticación que requiere el servicio. Una vez seleccionado nos permite introducir los datos necesarios para el tipo de autenticación seleccionado. Por defecto, no se usa autenticación.

Funciones Predefinidas (PF's)

  • deleteRest(resource, headers): permite configurar una petición HTTP de tipo Delete. Como parámetros de entrada tenemos:

      • Resource: indica el recurso dentro del EndPoint en el que se realizará la solicitud.

      • Headers(Opt.): indica las cabeceras que deben añadirse a la solicitud.

      • Charset(Opt.):  para elegir el charset que queremos utilizar.

      • Body(Opt.): indica el contenido del parámetro.

  • getALLJSONElementInfoByTagname: si el contenido de la respuesta a una petición es JSON o JsonArray, esta función permite recuperar todos los valores del atributo o elemento, con su nivel de profundidad en el JSON, y devolverlos bajo un TastTableData de tres columnas (TagName, Valor, Nivel). También se puede filtrar el resultado especificando el nivel bajo el que se debe encontrar el TagName. Como parámetros de entrada tenemos:

      • ResponseName: indica el nombre con el que se generó la respuesta Http.

      • JSonTagName: expresión de nombre de etiqueta utilizada para identificar el elemento.

      • LevelSelection:

    • getALLJSONElementValueByTagname: si el contenido de la respuesta a una petición es JSON, esta función permite recuperar el valor de algún elemento, utilizando el TagName para identificarlo. Devuelve todos los elementos. El resultado se presenta con los valores separados por el carácter |, en el campo Mensaje / Resultado / Valor. Como parámetros de entrada tenemos:

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • JSonTagName: expresión de nombre de etiqueta utilizada para identificar el elemento.

    • getALLXMLElementValueByTagName(StepResponse, ElementTag): si el contenido de la respuesta a una petición es XML, esta función permite recuperar todos los valores de los elementos, utilizando el TagName para identificarlo. En lugar de devolver sólo un elemento (el primero), este FP devuelve una lista de todos los elementos. Como parámetros de entrada tenemos:
        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • ElementTag: XML´s etiqueta utilizada para identificar el elemento.

    • getCookieValue(StepResponse, Cookie): recuperar el valor de la cookie indicada.
        • ResponseName: indica el nombre con el que se generó la respuesta Http.
        • Cookie: indica el nombre de Cookie´s a recuperar.
    • getElementsCountByJsonPath(JsonPath, ResponseName): devuelve el número de elementos que tienen el mismo JsonPath.

        • JsonPath: el JsonPath a buscar.

        • ResponseName: el nombre con el que se generó la respuesta HTTP.

    • getElementsCountByTagName(tagName, ResponseName): devuelve el número de elementos que tienen el mismo nombre de tag.

        • TagName: el nombre de tag a buscar.

        • ResponseName: el nombre con el que se generó la respuesta HTTP.

    • getElementsValueByJsonPath(JsonPath, ResponseName): devuelve todos los elementos que tienen el mismo JsonPath.

        • JsonPath: el JsonPath a buscar.

        • ResponseName: el nombre con el que se generó la respuesta HTTP.

    • getHeaderValue(StepResponse, Header): permite obtener el valor de una cabecera recibida en una respuesta HTTP.

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • Headers: el nombre de la cabecera de la que desea extraer el valor.

    • getHTMLElementValueByXpath(): si el contenido de la respuesta a una petición es HTML esta función permite recuperar el valor de un elemento empleando para identificar este, una expresión Xpath

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • XPathExp: expresión XPath utilizada para identificar el elemento.

    • getJSONElementValueByJsonPath(StepResponse, JSonPathExp): si el contenido de la respuesta a una petición es JSON, esta función permite recuperar el valor de un elemento, utilizando el nombre de JsonPath para identificarlo. Si hay más de un elemento, devuelve el primero.
        • ResponseName: indica el nombre con el que se generó la respuesta Http.
        • JSonPathExp: expresión de JSonPath utilizada para identificar el elemento.

    • getJSONElementValueByTagName(StepResponse, TagnameExp): si el contenido de la respuesta a una petición es JSON, esta función permite recuperar el valor de un elemento, utilizando el TagName para identificarlo. Si hay más de un elemento, devuelve el primero. El resultado se presenta con los valores separados por el carácter |, en el campo Mensaje / Resultado / Valor.

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • JSonTagName: expresión Tagname utilizada para identificar el elemento.

    • getResponseBody: obtener el cuerpo de la respuesta http, sin el código de respuesta ni otras cabeceras, sólo el cuerpo, es decir, el json o el xml.
    • getResponseStatus(StepResponse): permite recuperar el código de estado Http de la respuesta.

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

    • getResponseTime: retorna el tiempo empleado en milisegundos en recibir la respuesta a una solicitud. Para identificar la respuesta recibe un parámetro con el nombre de la variable HttpResponse de la que queremos obtener la información.
    • getRest(resource, headers, parameters): permite configurar una petición HTTP del tipo Get.

        • Resource: indica el recurso dentro del EndPoint en el que se realizará la solicitud.

        • Headers: indica las cabeceras que deben añadirse a la solicitud.

        • Parámetros: indica los parámetros que deben añadirse a la URL de la incidencia.

        • Charset: para elegir el charset que queremos utilizar.

    • getXMLElementValueByTagName(StepResponse,  ElementTag): si el contenido de la respuesta a una petición es XML, esta función permite recuperar el valor de un elemento, utilizando la etiqueta it´s para identificarlo. Si hay más de un elemento, devuelve el primero.

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • ElementTag: XML´s etiqueta utilizada para identificar el elemento.

    • getXMLElementValueByXPath(StepResponse, XPathExp): si el contenido de la respuesta a una petición es XML, esta función permite recuperar el valor de un elemento, usando para identificar este, una expresión XPath. Además permite buscar valores en respuestas con un tipo de contendio XHTML.

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • XPathExp: expresión XPath utilizada para identificar el elemento.

    • patchRest(resource, headers, content-type, body):  permite configurar una petición HTTP de tipo Patch.

        • Resource: indica el recurso dentro del EndPoint en el que se realizará la solicitud.

        • Headers: indica las cabeceras que deben añadirse a la solicitud.

        • Tipo de contenido: cabecera estándar HTTP que indica el tipo de contenido que se agrega al cuerpo de la solicitud.

        • Body: contenido de la solicitud Http.

    • postRest(resource, headers, content-type, body):  permite configurar una petición HTTP de tipo Post.

        • Resource: indica el recurso dentro del EndPoint en el que se realizará la solicitud.

        • Headers: indica las cabeceras que deben añadirse a la solicitud.

        • Content-type: cabecera estándar HTTP que indica el tipo de contenido que se agrega al cuerpo de la solicitud.

        • Body: contenido de la solicitud Http.

    • putRest(resource, headers, content-type, body): permite configurar una petición HTTP de tipo Put.

        • Resource: indica el recurso dentro del EndPoint en el que se realizará la solicitud.

        • Headers: indica las cabeceras que deben añadirse a la solicitud.

        • Content-type: cabecera estándar HTTP que indica el tipo de contenido que se agrega al cuerpo de la solicitud. 

     

    Content-Type.png

      •  
      •  

        • Body: contenido de la solicitud Http.

        • Charset: para elegir el charset que queremos utilizar.
    • responseBodyContainsText(responseName, searchValue): buscar en el campo cuerpo de la respuesta (stepResponse), si hay alguna coincidencia con el texto del parámetro searchValue. Rendimiento verdadero si es afirmativo.

        • ResponseName: indica el nombre con el que se generó la respuesta Http.

        • SearchValue: texto a buscar dentro del cuerpo de la respuesta.

    • setBasicAuthentication(user, password): permite configurar el esquema de autenticación de las peticiones que se envían al EndPoint como BasicAuthentication. Sobrescribe la configuración de seguridad realizada en la configuración del adaptador.

        • User: código de usuario utilizado como credencial.

        • Password: contraseña para presentar como credencial.

    • setBearerTokenAuthentication(token): permite configurar el esquema de autenticación de las peticiones que se envían al endpoint como BearerTokenAuthentication. Sobrescribe la configuración de seguridad realizada en la configuración del adaptador. Como parámetro de entrada tenemos:

        • Token: valor de Token que se presentará como credencial.

    • setDigestAuthentication(user, password, realm, nonce, algorithm, Qoq, NonceCount, ClientNonce, Opaque): permite configurar el esquema de autenticación de las peticiones que se envían al endpoint como Digest Authentication Schema. Sobrescribe la configuración de seguridad realizada en la configuración del adaptador.

        • Usuario: nombre de usuario utilizado como credencial.

        • Password: contraseña para presentar como credencial.

        • Realm: dominio de seguridad en el que debe realizarse la validación de seguridad. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos de la respuesta al desafío.

        • Nonce: nonce devuelto por el servidor. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos de la respuesta al desafío.

        • Algoritm: algoritmo utilizado para el cifrado. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos de la respuesta al desafío.

        • Qoq: calidad del código de protección. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos de la respuesta al desafío.

        • NonceCount: nonceCount asociado a la solicitud. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos de la respuesta al desafío.

        • ClienteNonce: nonce generado por el cliente. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos de la respuesta al desafío.

        • Opaque: opaque devuelto por el servidor. Es opcional, si no se conoce, el adaptador intentará realizar la validación con los datos obtenidos.

    • setNoneAuthentication(): permite configurar el método de autenticación de las peticiones que se envían al EndPoint como peticiones sin esquema de autenticación. Sobrescribe la configuración de seguridad realizada en la configuración del adaptador.

    Conceptos teóricos importantes relacionados con los Servicios Web


    Base URL

    Sería la parte de la URL que es común a todas las peticiones o peticiones sobre ese servicio web, de forma que el usuario no tenga que introducirla en cada mensaje que configure como servicio de petición.

    Datos de autenticación y autorización

    Se entiende que la primera interacción que el adaptador deberá realizar con el servicio web será la de autenticación y autorización. Actualmente existen varios métodos estándar diferentes para realizar este paso y otros propietarios que dejaría para desarrollar bajo demanda, es decir, si encontramos la necesidad.

    Resaltar que no son métodos de autenticación-autorización propios de los servicios Web Rest, más bien están asociados al protocolo Http, por lo que el desarrollo debe estar orientado a ser reutilizado por el adaptador GUI Html y el adaptador Webservices SOAP, si en el futuro se pretende acceder a alguna aplicación Web que utilice alguno de estos métodos para autenticarse-autorizarse.

    Tipos de autenticación

    Para administrar el campo authentication_type existe un campo de tipo combo, que contiene una autenticación definida, que debe ser enumerada por el usuario para su selección.

    Back to top