Etapa API Rest

La etapa API Rest importa datos de una API para iniciar un flujo de datos. Una API (Application Programming Interface) es un conjunto de reglas y estándares que permite que diferentes sistemas se comuniquen entre sí. Después de configurar la etapa, ejecuta el flujo y utiliza los datos devueltos por la API. Se encuentra en la categoría Fuente de Datos de la barra de herramientas.

Pestaña API

Configure aquí los datos principales de la conexión:

• Nombre: identifica la etapa. El campo es editable, defina el nombre que prefiera.

• URL del endpoint: dirección de acceso a la API.

• Método: informe si la API es GET o POST.

• ¿Tiene paginación?: habilite esta opción cuando la API esté paginada. Al habilitarla, elija el Tipo de paginación.

Cuando hay paginación, el tipo puede ser:

• Paginado por el índice de la página: las páginas se controlan por el número de página (página 1, página 2 y así sucesivamente). Informe la variable {page} en la URL donde va el número de página. Ejemplo: https://minhaapi.com.br/relatorio?empresa=1&data=2023-08-02&pagina={page}.

• Paginado por el índice de la línea: las páginas se controlan por el número de líneas. La solicitud informa la línea inicial y el límite de líneas a devolver. Use la variable {offset} para la línea inicial y {limit} para el límite de registros. Ejemplo: https://minhaapi.com.br/relatorio?empresa=1&data=2023-08-02&offset={offset}&limit={limit}.

Qué son GET y POST

GET y POST son métodos HTTP que indican la acción deseada en una solicitud. Toda solicitud necesita informar un método. Existen otros (PUT, DELETE, entre otros), pero los dos utilizados para obtener datos son GET y POST:

• GET: se utiliza cuando el objetivo es obtener datos.

• POST: se utiliza principalmente para enviar datos y, en algunos casos, también para obtenerlos.

Parámetros de URL

Puede informar parámetros para que se sustituyan en la URL antes de la conexión con la API. Hay dos tipos:

• Fijo: se completa con un valor fijo, como el código de la empresa o la moneda deseada.

• Fecha Ref.: envía la fecha de referencia de la ejecución del flujo. Durante la edición del flujo, se aplica la fecha de simulación (definida en la barra de Muestra de datos); durante la ejecución, se aplica la fecha de referencia informada.

Suponga que consulta los datos informando empresa y fecha en la URL. En lugar de la URL fija https://minhaapi.com.br/relatorio?empresa=1&data=2023-08-02, configure el endpoint con variables: https://minhaapi.com.br/relatorio?empresa={empresa}&data={data}. Los parámetros quedarían así: empresa como Fijo con el valor 1, y data como Fecha Ref. con el formato YYYY-MM-DD.

Opciones de autorización

Cuando la API requiera autorización de acceso, registre uno de estos tipos:

• Basic Authorization: informe el usuario y la contraseña de acceso.

• AWS Signature: para las API en el entorno de AWS (Amazon Web Services). Complete los campos AWS Access Key ID, AWS Secret Access Key, ServiceCode y Region Code.

• Bearer Token: informe el token.

• Ruta de Autenticación: configura una API para obtener el token de acceso, que luego se utiliza en la API que consulta los datos. Complete la Clave del parámetro (nombre del parámetro de autenticación enviado en el encabezado durante la ejecución) y el Prefijo (texto agregado antes del valor obtenido). Luego, haga clic en Configurar nueva ruta para definir la API que obtiene el token, seleccionando un campo para usar como token. Por ejemplo, si el retorno es un token Bearer, use Authorization como clave y Bearer como prefijo.

Pestaña Encabezado

Puede registrar parámetros de encabezado (header), con los mismos dos tipos disponibles en la URL:

• Fijo: se completa con un valor fijo, como el código de la empresa o la moneda deseada.

• Fecha Ref.: envía la fecha de referencia de la ejecución. En la edición del flujo se aplica la fecha de simulación; en la ejecución se aplica la fecha de referencia informada.

Pestaña Cuerpo

Disponible cuando el método es POST. Configure:

• Tipo de contenido: informe el formato del cuerpo. Las opciones son JSON (application/json), XML (application/xml) y XML (text/xml).

• Parámetros de cuerpo: registre los parámetros del cuerpo de la solicitud, en los tipos Fijo (valor fijo) o Fecha Ref. (fecha de referencia de la ejecución).

Las variables se declaran en el cuerpo entre llaves. Por ejemplo, para enviar empresa y fecha, el cuerpo sería { "codigoempresa": "{empresa}", "datacompetencia": "{data}" }, con los parámetros empresa como Fijo (valor 1) y data como Fecha Ref. (formato YYYY-MM-DD).

Pestaña Retorno

Defina aquí qué campos de la API se utilizarán como columnas de salida (paso obligatorio).

1. Ejecutar conexión: haga clic para ejecutar la llamada a la API.

2. Configurar columnas: después de la conexión, la plataforma muestra la lista de campos disponibles. Los iconos indican el tipo de campo:

• Icono #: campo de índice, que se muestra cuando hay una lista de datos.

• Icono @: campo devuelto por la API.

• Icono { }: una lista de datos.

1. Seleccione los campos que desea utilizar. Cada campo seleccionado ingresa en la lista de abajo con Origen (origen del campo en el árbol de datos), Nombre de la columna, Muestra (primer valor encontrado) y Tipo de datos (tipo identificado). Cuando el tipo sea Fecha, seleccione al lado el formato de la fecha.

2. Guardar: guarda las configuraciones. Para salir sin guardar y volver al Designer, use Cerrar.

Artículos relacionados

• Etapa Transformar SQL

• Etapa Dattos IA