Quick BI:Crear un origen de datos de API

Paso 1: Establecer la conexión de API

Configure la información básica de autenticación, el método de conexión y los parámetros de la conexión de API.

1. Configure la información de cada elemento en Basic Authentication.

   Nombre del parámetro	Descripción
   Connection Name	Nombre personalizado para la interfaz de API, que se muestra en la lista de orígenes de datos de Quick BI. El nombre puede contener caracteres chinos, números, letras, guiones bajos (_) o guiones (-).
   Interface Address	URL de solicitud de la interfaz de API.
   Request Type	Tipo de solicitud de la interfaz de API. Se admiten dos tipos: GET y POST. El valor predeterminado es GET. GET: Recupera recursos del servidor. No permite modificar los datos del servidor. POST: Envía datos al servidor, como formularios. Permite modificar los datos del servidor.

2. Seleccione el Connection method. Puede elegir entre Extract o Direct connection.

   • Extract: Admite actualizaciones de datos manuales o programadas. Adecuado para escenarios con bajos requisitos de tiempo real.

   • Direct connection: Se conecta directamente a la API para obtener actualizaciones de datos en tiempo real. Recomendado para volúmenes pequeños de datos con altos requisitos de tiempo real.

     La conexión directa admite Short-term cache, con duraciones de caché de 5, 10 o 30 minutos. El uso de caché evita solicitudes repetidas durante un periodo determinado, protege el servicio de API de origen y reduce los costos de llamada.

     Nota

     En el modo de conexión directa, the data volume returned by each request must meet the following conditions: no more than 10 MB, no more than 100 columns, and no more than 1,000 rows.

     

3. (Opcional) Configure los parámetros que se pasarán en Parameter settings.

   Nombre del parámetro	Descripción
   Common Parameters	Los parámetros situados después de la dirección de solicitud son parámetros comunes, con el formato url?key1=value1&key2=value2. Haga clic en Add Parameter para pasar parámetros mediante parámetros comunes. Por ejemplo, en interfaces de API con grandes volúmenes de datos, puede solicitar mediante paginación proporcionando un parámetro dinámico ${PageIndex} .Para obtener información detallada sobre los parámetros, consulte Parameter Introduction.
   Header Parameters	Parámetros en el encabezado de la solicitud HTTP. Se utilizan normalmente para valores constantes. Puede agregar (①), eliminar (②) y modificar (③) manualmente los parámetros de encabezado. Para obtener información detallada sobre los parámetros, consulte Parameter Introduction.
   Request Body	Disponible cuando el Request type en Basic Authentication es POST. El cuerpo de la solicitud contiene los datos que se enviarán al servidor. Escriba su contenido y formato según los requisitos de campo de la API. Quick BI admite dos formatos de cuerpo de solicitud: JSON y x-www-form-urlencoded. JSON: Maneja estructuras de datos complejas con objetos o matrices anidadas. x-www-form-urlencoded: Maneja datos simples de pares clave-valor para envíos de formularios.
   Authorization Verification	Seleccione sin autorización, Basic Authentication o Digest Authentication. Para obtener información específica, consulte Autenticación HTTP 01: autenticación básica y autenticación por resumen.
   Pre-request	Si la API requiere pasos de preparación antes de una solicitud, como obtener un token mediante una interfaz de autenticación, puede configurar una solicitud previa. El sistema ejecuta las solicitudes previas en secuencia antes de llamar a la API principal. Los resultados de respuesta se pueden almacenar como parámetros dinámicos y referenciarlos en los parámetros de encabezado, parámetros comunes, cuerpo de solicitud u otras solicitudes previas de la API principal. Para ver ejemplos de uso de solicitudes previas, consulte Operation Example. Nota Se admiten un máximo de 3 solicitudes previas.

4. Haga clic en Test connection y, tras completarse correctamente, continúe con el Next step.

Paso 2: Analizar los resultados de la solicitud

El área Data structure dentro de Parse request results muestra todos los campos devueltos por la solicitud de API. Seleccione los campos necesarios y modifique sus tipos según sea necesario.

Paso 3: Configuración de sincronización de datos

Establezca el ciclo de actualización del origen de datos de API en Data synchronization settings.

1. Haga clic en la lista desplegable Update cycle y seleccione un ciclo de actualización. Puede elegir actualización manual o actualización programada.

   Nota

   El ciclo de actualización solo aplica cuando el método de conexión está configurado como extracción.

   

   • Manual update: La sincronización de datos ocurre únicamente cuando se activa manualmente.

   • Scheduled update: Configure la frecuencia de actualización (diaria u horaria) para sincronizar datos en intervalos programados.

2. Haga clic en Finish para crear el origen de datos de API. El nuevo origen de datos aparecerá en la interfaz de gestión de orígenes de datos de API.

   Haga clic en el icono junto a un origen de datos de API para editarlo.

   Nota

   No es posible editar el método de conexión.

   

Paso 1: Establecer la conexión de API

Configure la información de conexión de API de la siguiente manera.

1. Configure la información de Basic Authentication.

   • Connection name: En este ejemplo, utilizamos el significado comercial de la interfaz de API como nombre e introducimos Get User Attendance Data.

   • Interface address: Obtenga la dirección de solicitud desde la página de documentación de la API.

   • Request type: Obtenga el tipo de solicitud desde la página de documentación de la API. En este ejemplo, es POST.

2. Configure el Connection method.

   En este ejemplo, solo necesitamos obtener datos de asistencia del día actual, con bajos requisitos de tiempo real, por lo que el método de conexión se establece en Extract.

   

3. Configure la Pre-request.

   Antes de llamar a la interfaz Get User Attendance Data (la API principal), debe obtener un access_token mediante la interfaz Obtener access_token de aplicación interna empresarial e inyectarlo en la dirección de solicitud de la API principal. Configure la solicitud previa para obtener el access_token y añadirlo como parámetro común a la dirección de solicitud de la API principal.

   1. Haga clic en Add pre-request bajo la pestaña Pre-request.

   2. En el cuadro de diálogo Add pre-request, complete la siguiente configuración.

      • Connection name: En este ejemplo, introducimos el significado comercial de la interfaz de autenticación, que es Get enterprise internal application access_token.

      • Interface address: Obtenga la dirección de solicitud de la interfaz de autenticación a través de la documentación de la interfaz.

      • Request type: Obtenga el tipo de solicitud de la interfaz de autenticación a través de la documentación de la interfaz. En este ejemplo, es GET.

      • Common parameters: Según la documentación de la interfaz, la dirección de solicitud debe incluir los parámetros appkey y appsecret, así que agregue appkey y appsecret en los parámetros comunes e introduzca los valores correspondientes. Una vez completado, los parámetros se añadirán automáticamente a la dirección de solicitud.

      • Header parameters: En este ejemplo, mantenemos la configuración predeterminada, es decir, seleccionamos Content-Type como application/json para indicar al servidor receptor que el formato de transmisión de datos es JSON; y Connection como keep-alive para indicar al servidor receptor que la solicitud actual requiere una conexión persistente.

   3. Haga clic en Test connection para ver la información de retorno en el módulo Request result. Quick BI analiza automáticamente los campos en el resultado de la solicitud. En el módulo Dynamic parameters, seleccione los campos que desea usar como parámetros dinámicos y referéncielos en la API principal mediante ${parameter name}.

      En este ejemplo, pase el access_token de la solicitud previa como parámetro dinámico a la API principal creando el parámetro dinámico access_token.

      Nota

      Se pueden agregar un máximo de 10 parámetros dinámicos.

      

4. Configure los Common parameters.

   En este ejemplo, referencie el parámetro dinámico access_token de la solicitud previa en los parámetros comunes de la API principal mediante ${parameter name}. Haga clic en Add parameter bajo la pestaña Common parameters.

   Nota

   Los parámetros dinámicos se pueden referenciar en los parámetros comunes, parámetros de encabezado, cuerpo de solicitud de la API principal u otras solicitudes previas. Puede elegir según sea necesario en las operaciones reales.

   

5. Introduzca el nombre del parámetro, haga clic en el icono en el cuadro de entrada de valor del parámetro, seleccione un parámetro del panel de variables y haga clic en el icono para guardar.

   En este ejemplo, cambie a la pestaña Dynamic parameters, que enumera los parámetros dinámicos creados en el flujo actual, y seleccione ${access_token}.

6. Configure el Request body.

   En este ejemplo, el tipo de solicitud es POST, así que escriba el cuerpo de la solicitud según el Get enterprise internal application access_token API's request parameters.

   • JSON format example code is as follows:

     {
         "work_date": "2024-11-14",
         "userid": "user01"
     }

   • El código de ejemplo en formato x-www-form-urlencoded es el siguiente:

     work_date=2024-11-14&userid=user01

7. Otras configuraciones de parámetros.

   En este ejemplo, los parámetros de encabezado y la verificación de autorización mantienen la configuración predeterminada.

8. Haga clic en Test connection y, tras completarse correctamente, continúe con el Next step.

Paso 2: Analizar los resultados de la solicitud

En Parse request results, seleccione los campos requeridos, ajuste sus tipos de campo y haga clic en Next step.

Paso 3: Configuración de sincronización de datos

1. En la sección de configuración de sincronización de datos, establezca el ciclo de actualización del origen de datos de API de este ejemplo en Manual update.

   

2. Haga clic en Finish para crear correctamente el origen de datos de API Get User Attendance Data.