DataWorks:Introducción a DataService Studio

Desarrollo de API

Data Push

Data Push le permite enviar datos proactivamente a una audiencia objetivo de forma programada. Puede crear una tarea de Data Push para personalizar y orquestar contenido, como texto enriquecido y tablas, desde diversos orígenes de datos. Establezca la frecuencia de envío y configure los destinatarios y canales según sus necesidades comerciales. Para obtener más información, consulte Data Push.

Requisitos previos

• API Gateway debe estar activado. Para obtener más información, consulte Activate API Gateway.

• Se ha creado un origen de datos de destino. Este tema utiliza un origen de datos MySQL como ejemplo. El origen de datos proporciona los datos de entrada necesarios para generar la API. Para obtener más información, consulte Configure a data source.

• Se ha creado un Serverless resource group y se ha configurado una cuota para DataService Studio. Para obtener más información, consulte Configure a quota for DataService Studio in a Serverless resource group.

Paso 1: Crear origen de datos y configurar la red

Antes de crear una API, agregue su base de datos o almacén de datos como origen de datos de DataWorks y asegúrese de que el resource group de DataService Studio pueda conectarse a él. Esto permite que DataWorks acceda al origen de datos cuando se llama a una API.

Durante el desarrollo, DataService Studio recupera el esquema de la tabla de este origen de datos para ayudarle a configurar los parámetros de solicitud y respuesta. En el momento de la llamada, ejecuta consultas contra el origen de datos. Para ver los orígenes de datos compatibles, consulte List of data sources for DataService Studio.

Este ejemplo muestra cómo crear un origen de datos MySQL llamado rds_workshop_log y probar su conectividad con un Serverless resource group.

1. Vaya a la consola de DataWorks, seleccione el workspace objetivo y haga clic en Go to Management Center.

2. En el panel de navegación izquierdo, haga clic en Data Sources.

3. Cree un origen de datos y pruebe su conectividad de red.

   1. Haga clic en Add Connection y seleccione un tipo de origen de datos.

      Este ejemplo utiliza MySQL.

   2. Configure la información del origen de datos.

      Configure los parámetros según se le indique en la página. Para obtener más información, consulte Configure a MySQL data source.

   3. Seleccione un Serverless resource group y pruebe la conectividad entre el resource group y el origen de datos.

      Nota

      • Si tiene tareas de alta concurrencia que no pueden ejecutarse fuera del horario pico, debe utilizar recursos dedicados para garantizar llamadas a la API de alta concurrencia y alta frecuencia. Le recomendamos adquirir y utilizar un Serverless resource group de DataWorks.

      • Cuando utilice un Serverless resource group, debe configure a quota for DataService Studio in the Serverless resource group.

      • Si la prueba de conectividad falla, compruebe su configuración siguiendo las instrucciones en Network connections and whitelists.

   4. Haga clic en Complete para crear el origen de datos.

Paso 2: Crear un grupo de API

DataService Studio atiende a sistemas externos a través de API Gateway. En API Gateway, un grupo es la unidad de gestión para las APIs y está asociado con el nombre de dominio de la dirección de llamada. Cree un grupo de API en API Gateway antes de crear una API en DataService Studio.

1. Vaya a la consola de API Gateway. En la página Group Management, haga clic en Create Group.

2. Introduzca la información del grupo y complete la creación. Este ejemplo crea un grupo llamado Workshop.

Paso 3: Crear un proceso de negocio

Los procesos de negocio organizan el desarrollo de APIs en torno a unidades de negocio y gestionan archivos como APIs y funciones. Cree un proceso de negocio antes de crear una API.

1. Inicie sesión en la consola de DataWorks. En la región objetivo, haga clic en Data Analysis and Service > DataService Studio en el panel de navegación izquierdo. Seleccione un workspace de la lista desplegable y haga clic en Go to DataService Studio.

2. Cree un proceso de negocio.

   En la página Data Services > Service Development, cree un proceso de negocio de una de las siguientes maneras:

   • Método 1: Haga clic en el icono y seleccione Create Workflow.

   • Método 2: En el panel de navegación izquierdo, haga clic con el botón derecho en la carpeta Workflow y seleccione Create Workflow.

3. Configure los parámetros del proceso de negocio.

   Configuración	Descripción
   Workflow Name	Introduzca un nombre personalizado basado en su escenario de negocio. Este ejemplo crea un proceso de negocio llamado DataService.
   API grouping	Seleccione un grupo de API para gestionar sus APIs. Este ejemplo utiliza el grupo Workshop creado en el Paso 2. Nota Un grupo de API es una colección de APIs para una función o escenario específico y la unidad más pequeña para la gestión de APIs en API Gateway. Si necesita crear un nuevo grupo, consulte Step 2: Create an API group.

4. Haga clic en Determine para crear el proceso de negocio.

   Una vez creado el proceso de negocio, puede verlo en el panel de navegación izquierdo de la página de DataService Studio.

Paso 4: Generar una API

Después de crear un proceso de negocio, puede crear APIs dentro de él.

1. Genere una API.

   En la página Data Services > Service Development, genere una API de una de las siguientes maneras:

   • Método 1: Haga clic en el icono y elija Create API > Generate API.

   • Método 2: En el panel de navegación izquierdo, haga clic con el botón derecho en el proceso de negocio de destino y elija Create > API > Generate API.

2. Defina las propiedades de la API.

   En el cuadro de diálogo Generate API, configure la información de la API. La siguiente tabla describe los parámetros principales.

   Elemento de configuración	Descripción
   Location	El directorio dentro del proceso de negocio donde se almacena la API. Importante Le recomendamos seleccionar primero la carpeta de destino. Si no puede seleccionar una, create a business process primero.
   API Mode	Seleccione el modo para crear la API. Puede elegir la interfaz de usuario sin código o el editor de código. Codeless UI: Configure rápidamente una API de datos sin escribir código. Code editor: Admite funciones avanzadas como uniones de tablas, consultas complejas y funciones de agregación. Puede escribir consultas SQL personalizadas para la API a fin de satisfacer requisitos de consulta avanzados. Este tema utiliza la interfaz de usuario sin código como ejemplo. Para obtener detalles sobre ambos modos, consulte Overview of API generation.
   API Name	Introduzca un nombre personalizado para la API. Este tema utiliza rpt_user_info_all_d como ejemplo.
   APIPath	La ruta de almacenamiento de la API. Esta es la URI de la solicitud relativa al host del servicio. Esta ruta se utiliza para construir la dirección de llamada de la API. Este tema utiliza /user como ejemplo.
   Protocol	Se admiten HTTP y HTTPS. Para llamar a la API a través de HTTPS, vincule un nombre de dominio independiente y cargue un certificado SSL en la consola de API Gateway después de publicar la API en el gateway. Para obtener más información, consulte Support for HTTPS.
   Request Method	Se admiten GET y POST. Nota Si selecciona GET como método de solicitud, solo puede establecer los Request Parameters de una Parameter Position en QUERY. Si selecciona POST como método de solicitud, puede establecer los Request Parameters de una Parameter Position en QUERY o BODY.
   Response Type	Solo se admite JSON.
   Visible Scope	La visibilidad de la API después de su creación. Las opciones son Work space y Private. Work space: La API es visible para todos los miembros del workspace actual. Private: La API es visible solo para el propietario de la API. No se admite la autorización. Este ejemplo establece el alcance de visibilidad en Work space.

3. Configure los parámetros de la API.

   En la página de edición de la API, configure los siguientes parámetros.

   1. Seleccione el origen de datos para la API.

      En el área Table, seleccione la tabla del origen de datos para generar la API.

      Parámetro	Descripción
      Data Source Type	Seleccione el tipo de origen de datos desde el cual crear la API. Este tema utiliza MySQL como ejemplo.
      Data Source Name	Seleccione el origen de datos específico del tipo elegido para generar la API. Este ejemplo utiliza el origen de datos rds_workshop_log creado en Step 1: Create a data source and configure network connectivity.
      Data Source Environment	Los workspaces en modo estándar permiten acceder a orígenes de datos tanto en el entorno de desarrollo como en el de producción. Para obtener más información sobre las diferencias entre los dos entornos, consulte Differences between workspace modes. Este ejemplo selecciona el Production Environment.
      Data Table Name	Seleccione la tabla de datos en el origen de datos desde la cual generar la API. Este tema utiliza la tabla rpt_user_info_all_d en el origen de datos rds_workshop_log como ejemplo.

   2. Defina los parámetros de solicitud y respuesta.

      Después de seleccionar una tabla, sus campos aparecen en el área Select Parameters. Luego puede elegir los campos para usar como parámetros de solicitud y respuesta. Para ordenar los campos, agregue los campos objetivo al área Sort field y ajuste su orden.

      En este ejemplo, el parámetro de solicitud es uid, y los parámetros de respuesta son todos los campos de la tabla.

      Nota

      En el panel de navegación derecho, haga clic en Request Parameters o Response Parameters para modificar la configuración de los parámetros, como el tipo de campo, el valor de muestra y el valor predeterminado. Configure estos ajustes según sus necesidades reales.

4. Configure el resource group de la API.

   En la página de edición de la API, haga clic en Resource Group for DataService Studio a la derecha para configurar el resource group. Dado que el public resource group for DataService Studio is being discontinued predeterminado ya no se recomienda, las nuevas APIs deben utilizar un exclusive service resource group. Seleccione un Serverless resource group (recomendado) con una configured quota for DataService Studio, o un exclusive resource group for DataService Studio.

Paso 5: Probar la API

Debe probar una API antes de poder publicarla. Una vez generada la API, haga clic en Test en la esquina superior derecha de la página de edición de la API para comprobar que la solicitud y la respuesta sean las esperadas. Este ejemplo establece el valor del parámetro de solicitud uid en 0016359810821 para probar el resultado. Para obtener más información sobre las pruebas, consulte Test an API.

Paso 6: Publicar la API

Una API que supera las pruebas debe publicarse antes de que otros servicios puedan llamarla. En la esquina superior derecha de la página de edición de la API, haga clic en Submission y seleccione la versión a publicar. Para obtener más información, consulte Test, publish, and manage API versions.

Paso 7: Llamar a la API

Se admiten los siguientes métodos de autenticación para llamar a las APIs:

• Simple Authentication: Baja seguridad. Adecuado para escenarios como informes y paneles de datos.

• Encrypted Signature Authentication: Alta seguridad. Adecuado para escenarios de desarrollo de aplicaciones.

1. En la barra de menú superior de DataService Studio, haga clic en Service Management para ir a la página de gestión de servicios.

2. En el panel de navegación izquierdo, seleccione Call APIs.

   Las APIs publicadas están disponibles en API Gateway. Puede llamar a la API utilizando un SDK de API Gateway. Para obtener más información, consulte Examples of calling an API from a client.

Paso 8: Ver y gestionar APIs

En la página Service Management, puede ver las APIs publicadas y realizar operaciones como cancelar la publicación, autorizar y ver detalles de llamadas.