API REST

Creando un conector

Para crear un conector de API REST, siga los pasos que se indican a continuación:

  1. Acceda a la pantalla Connector Manager desde el menú a la izquierda o haciendo clic en la tarjeta en la pantalla de Welcome.

  2. Haga clic en + NEW CONNECTOR en la esquina superior derecha de la pantalla.

  3. Seleccione la tarjeta REST API.

  4. Importe un archivo con la especificación Open API 3.0.0.

    Al hacer clic en la tarjeta del conector, aparecerá una ventana modal para importar el archivo. Haga clic en SELECT FILE para encontrarlo y después haga clic en IMPORT.

    Solo está permitido importar archivos locales com las siguientes extensiones:

    • json;

    • yaml;

    • yml.

    Cuando se importa el archivo, el sistema comprobará si hay errores de estructura y si el archivo está de acuerdo con la versión soportada.

    Después de la validación, la pantalla de configuración del conector se abre y sus campos se rellenan automáticamente con los datos importados.

  5. Si quiere cambiar la información cargada automáticamente, edite los campos:

    • Name: nombre del conector.

    • Version: versión del conector.

    • Description: descripción del conector.

    • Add icon: opción para añadir un icono para representar el conector en el Flow.

  6. Seleccione los endpoints del archivo Open API 3.0.0 que quiere utilizar en el conector.

    Haga clic en Select All para seleccionar todos los endpoints disponibles.

    A la derecha de los endpoints, verá la solicitud (request) y la respuesta (response) de cada endpoint seleccionado.

  7. Haga clic en CREATE.

create rest api connector
No está permitido editar un conector de API REST.

Configurando un conector

Tras crear el conector, usted debe configurarlo en la pantalla Flow. Para ello, siga los pasos que se indican a continuación:

Añadiendo el conector al canvas

  1. Acceda a la pantalla Integration Flows y seleccione su flujo de integración.
    Si desea crear un nuevo flujo, haga clic en + NEW FLOW y acceda a la pantalla Flow.

    Consulte nuestro tutorial sobre cómo crear su primer flujo de integración.

  2. Haga clic en el icono icono de conector con signo más del menú de edición de la izquierda.

  3. Seleccione el conector que desee. Puede utilizar la barra de búsqueda search steps icon para encontrarlo.

  4. Haga clic en el icono de edición icono de lápiz para configurar su formulario.

Cada conector sólo permite una conexión al step anterior y una conexión al step siguiente.

Para copiar el step, haga clic en el botón icono de copia. Si el formulario del step ya está configurado, los ajustes también se copian.

Para eliminar el conector del canvas, selecciónelo y haga clic en el botón icono de papelera.

Configurando el formulario

A continuación, sigue las secciones del formulario del conector de API REST y aprende a configurarlas:


Information y Requirements

Estas dos secciones tienen los siguientes campos y botones:

  • Name: nombre del step conector. Campo para edición.

  • Connector: campo bloqueado que sólo identifica el conector.

  • Route: seleccione el método HTTP y el path que el step conector utilizará. Usted también puede escribir el método HTTP o el path para filtrar los resultados.

  • URL: URL que hará la petición.

  • Request Timeout: inserte el timeout de la petición en milisegundos. Por defecto, el valor es de 3000 milisegundos y el valor máximo es de 300000 ms.

    Haciendo clic en el botón de Properties icono de lista a la derecha de los campos URL y Request Timeout, puede:
    a. Filtrar y mostrar variables de entorno y el payload de steps anteriores (si los steps están conectados) para uso en la configuración del formulario.
    b. Crear expresiones utilizando el Expression Builder.

  • Security: habilita automáticamente el tipo de seguridad ya configurado en Authorizations. Si hay más de un tipo de seguridad configurado, el campo mostrará un listado con las opciones. Si el conector no tiene ningún tipo de seguridad habilitado, por defecto el campo mostrará la opción No Auth.

  • Ignore Errors: por defecto, este botón está desactivado y puede activarlo. Compruebe más detalles sobre la función de Ignore Errors en la tabla abajo:

    Activado switch

    Desactivado switch off

    La ejecución del flujo continúa, incluso si hay errores en el proceso.

    La ejecución se detendrá inmediatamente.

    Los logs muestran el step con un error.

    Los logs muestran la ejecución hasta el step con error.

    Se ejecutarán los steps posteriores.

    No se ejecutará ningún step posterior.
    connector form



Body

Para configurar su payload usando la pestaña Body, tiene dos opciones:

body connector


Data Mapping

Con Data Mapping, puede mapear sus datos manualmente, eligiendo qué datos quieres mapear y transformar.

Para ello, siga los siguientes pasos:

  1. Haga clic en + CREATE DATA MAPPING.

    Tras hacer clic en el botón, se abrirá una nueva pantalla:

    dataMapping

  2. En FROM, seleccione uno o más atributos para mapear y transformar. Ej: "First_name" y "Last_name". Esta sección muestra los datos de los steps anteriores y las variables de entorno.

  3. En TO, seleccione sólo un atributo. Por ejemplo: "Name". En la imagen de arriba, los atributos "First_name" y "Last_name" se transformarán en "Name". Esta sección muestra las propiedades relacionadas con el body del conector.

  4. En EXPRESSION, se ven los atributos seleccionados en las columnas FROM y TO. Si desea crear la expresión manualmente, introduzca los atributos de entrada o cree una expresión haciendo clic en el botón fx-button de la derecha. Actualmente sólo está disponible la función Concat y no hay límite de caracteres.

  5. Haga clic en el botón ADD MAPPING para registrar la asignación realizada.

    Puede repetir los pasos anteriores tantas veces como sea necesario.

  6. En DATA MAPPING FIELDS, compruebe el mapeo de datos. Cada fila muestra el atributo de entrada (o expresión) y el atributo de salida en las columnas respectivas.

    Una flecha gris entre las columnas FROM/TO indica la ausencia de una expresión.

    Para eliminar una fila, basta con seleccionarla y hacer clic en icono de papelera a la derecha del nombre de la sección.

  7. Haga clic en CONFIRM para guardar la asignación de datos.

Una vez guardado, podrá visualizarlo en la pestaña Body y se habilitará la opción de edición.


Data Mapping con Full Body

En la esquina superior derecha de Data Mapping, puede activar o desactivar el botón FULL BODY. Así, la solicitud del conector se envía con las propiedades, estructuras y valores de la solicitud de llamada y no tienes que mapearlos uno a uno. Activando el botón, automatiza todo el proceso de mapeo de datos.

full body

Para automatizar el proceso, siga estos pasos:

  1. Activar FULL BODY.

  2. En el campo Input Data, seleccione el step para aplicar la asignación de datos. El body completo del step seleccionado se incluirá en la solicitud del conector. Verá los datos request y response de los conectores y los datos request del trigger.

  3. En Full Data Mapping, visualice el mapeo realizado automáticamente transformando los campos FROM en campos TO.

  4. Haga clic en CONFIRM para guardar el mapeo de datos.

Una vez guardado, podrá visualizarlo en la pestaña Body y se habilitará la opción de edición.



Haciendo clic en la pestaña Header, se pueden ver los headers de la petición asociados a la Route elegida al configurar el formulario del conector de API REST.

Configure los siguientes campos obligatorios:

  • Name: por defecto, el formulario carga el nombre de los headers automáticamente. Si no hay ningún header asociado a su ruta conector, puede introducir el nombre manualmente.

  • Value: inserte el valor del header. Puede hacerlo manualmente o utilizando el botón icono de expression para acceder al Expression Builder. En este caso, puede crear expresiones o simplemente utilizar la columna Properties para seleccionar los atributos y hacer clic en CONFIRM.

Para añadir más valores, haga clic en icono del signo más.
Para eliminar el valor, haga clic en icono de la papelera.
header connector



Query

Haciendo clic en la pestaña Query, se pueden ver las queries de la petición asociadas a la Route elegida al configurar el formulario del conector de API REST.

Configure los siguientes campos obligatorios:

  • Name: por defecto, el formulario carga el nombre de las queries automáticamente. Si no hay ninguna query asociada a su ruta conector, puede introducir el nombre manualmente.

  • Value: inserte el valor de la query. Puede hacerlo manualmente o utilizando el botón icono de expression para acceder al Expression Builder. En este caso, puede crear expresiones o simplemente utilizar la columna Properties para seleccionar los atributos y hacer clic en CONFIRM.

Para añadir más valores, haga clic en icono del signo más.
Para eliminar el valor, haga clic en icono de la papelera.
query connector



Path

Haciendo clic en la pestaña Path, se pueden ver los paths de la petición asociados a la Route elegida al configurar el formulario del conector de API REST.

Configure los siguientes campos obligatorios:

  • Name: por defecto, el formulario carga el nombre de los paths automáticamente. Si no hay ningún path asociado a su ruta conector, el campo se bloquea.

  • Value: inserte el valor del path. Puede hacerlo manualmente o utilizando el botón icono de expression para acceder al Expression Builder. En este caso, puede crear expresiones o simplemente utilizar la columna Properties para seleccionar los atributos y hacer clic en CONFIRM.

path connector

Una vez finalizada la configuración del step conector, haga clic en SAVE.

Expression Builder

El componente Expression Builder le permite crear expresiones con parámetros y variables mediante funciones y condiciones disponibles dentro del componente. Así, puede ajustar la expresión según lo requieran sus necesidades.

Puede crear expresiones para los siguientes campos:

  • URL;

  • Request Timeout.

Siga los pasos a continuación para acceder a la pantalla de Expression Builder:

  1. Haga clic en el icono Properties icono de lista, a la derecha de los campos URL o Request Timeout.

  2. A continuación, haga clic en el icono icono de expresion de la esquina superior derecha.

expression builder connector

La pantalla de Expression Builder contiene las siguientes secciones:

  • Properties: muestra los datos de los steps anteriores y de las variables de entorno. Puede filtrar los atributos utilizando el campo de búsqueda situado en la parte superior de la sección y haciendo clic en icono lupa. Puede seleccionar más de un atributo. Al seleccionarlo, el atributo aparece en el campo Expression.

  • Expression: campo para insertar los atributos de entrada o crear una expresión haciendo clic en el botón boton fx a la derecha. Solo la función Concat está disponible para crear la expresión.

Al seleccionar dos o más atributos en el campo Properties, la creación de una expresión será obligatoria.

Para guardar la información, haga clic en CONFIRM y, para salir de la pantalla, y cancelar la operación, haga clic en X, en la esquina superior derecha.

Alerta alertIcon

Verá un icono de alerta en el step conector si los campos siguientes no están configurados:

  • Route

  • URL

  • Request Timeout

  • Security

También verá la alerta si:
- las variables registradas en Environment Variables o
- los atributos registrados en steps anteriores
se modifican o eliminan mientras se siguen utilizando en el step configurado.
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]