Etapa API Rest
La etapa API Rest importa datos de cualquier sistema que disponga de una API REST — la salida en JSON se convierte automáticamente en columnas tabulares para su uso en el flujo. Úsela cuando el sistema no tenga un conector nativo en la plataforma, o cuando el dato que necesita no esté en los informes del conector. La API Rest se encuentra en la categoría Fuente de Datos de la barra de herramientas.
Cómo configurar
La configuración se organiza en cuatro pestañas.
Pestaña API
Nombre: identifica la etapa en el flujo.
Método HTTP: GET o POST, según la API consultada.
URL del endpoint: dirección de la API.
Tiene paginación: actívelo cuando la API divida la salida en páginas — la plataforma recorre las páginas automáticamente (por número de página o por desplazamiento, según la API).
Variables de URL: parámetros dinámicos de la llamada, incluidos valores calculados a partir de la fecha de referencia de la ejecución.
Opciones de Autorización: habilita la autenticación — se admiten usuario y contraseña (Basic), token (Bearer), firma HTTP y firma AWS, además de ruta de autenticación (una llamada previa que obtiene el token usado en las llamadas siguientes).
Pestaña Encabezado
Variables de Encabezado: encabezados HTTP adicionales exigidos por la API (p. ej.:
Content-Type).
Pestaña Cuerpo
Cuerpo de la solicitud, para métodos POST.
Pestaña Retorno
Ejecutar Conexión: prueba la llamada directamente desde el editor y muestra el estado, el tiempo y el tamaño de la respuesta.
Navegador de la estructura: el JSON devuelto aparece como un árbol — marque los campos que desea importar.
Mapeo de columnas: para cada campo seleccionado, defina el nombre de la columna y el tipo de dato (alfanumérico, numérico o fecha).
Ejemplo de uso
Una empresa necesita la cotización diaria del dólar para convertir saldos. En la etapa API Rest, informa la URL de la API de cambio con una variable de fecha rellenada por la fecha de referencia, prueba la conexión en la pestaña Retorno, selecciona los campos de fecha y valor de compra en el árbol del JSON y asigna nombres a las columnas. En cada ejecución, la cotización del día entra en el flujo y puede cruzarse con las demás fuentes mediante una etapa Buscar.
Atención — volumen de datos: la integración vía API no se recomienda para volúmenes superiores a 500 mil registros por ejecución, ya que puede generar lentitud y fallos. Para grandes volúmenes, prefiera la etapa Base de Datos o el intercambio de archivos.
Artículos relacionados
Integraciones personalizadas mediante API Rest y conectores SQL
Etapa Base de Datos
Etapa ERP