DataWorks:Getting started with DataService Studio

API development

Data Push

Data Push lets you proactively send data to a target audience on a schedule. You can create a Data Push task to customize and orchestrate content, such as rich text and tables, from various data sources. Set the push frequency and configure recipients and channels based on your business needs. For more information, see Data Push.

Step 1: Create data source and configure network

Before you create an API, add your database or data warehouse as a DataWorks data source and ensure the DataService Studio resource group can connect to it. This allows DataWorks to access the data source when an API is called.

During development, DataService Studio retrieves the table schema from this data source to help you configure request and response parameters. At call time, it executes queries against the data source. For supported data sources, see List of data sources for DataService Studio.

This example shows how to create a MySQL data source named rds_workshop_log and test its connectivity with a Serverless resource group.

1. Go to the DataWorks console, select the target workspace, and click Go to Management Center.

2. In the left-side navigation pane, click Data Sources.

3. Create a data source and test its network connectivity.

   1. Click Add Connection and select a data source type.

      This example uses MySQL.

   2. Configure the data source information.

      Configure the parameters as prompted on the page. For more information, see Configure a MySQL data source.

   3. Select a Serverless resource group and test the connectivity between the resource group and the data source.

      Note

      • If you have high-concurrency tasks that cannot be run during off-peak hours, you must use dedicated resources to ensure high-concurrency and high-frequency API calls. We recommend that you purchase and use a Serverless resource group from DataWorks.

      • When you use a Serverless resource group, you must configure a quota for DataService Studio in the Serverless resource group.

      • If the connectivity test fails, check your configuration by following the instructions in Network connections and whitelists.

   4. Click Complete to create the data source.

Step 2: Create an API group

DataService Studio serves external systems through API Gateway. In API Gateway, a group is the management unit for APIs and is associated with the call address domain name. Create an API group in API Gateway before creating an API in DataService Studio.

1. Go to the API Gateway console. On the Group Management page, click Create Group.

2. Enter the group information and complete the creation. This example creates a group named Workshop.

Step 3: Create a business process

Business processes organize API development around business units and manage files such as APIs and functions. Create a business process before you create an API.

1. Log on to the DataWorks console. In the target region, click Data Analysis and Service > DataService Studio in the left-side navigation pane. Select a workspace from the drop-down list and click Go to DataService Studio.

2. Create a business process.

   On the Data Services > Service Development page, create a business process in one of the following ways:

   • Method 1: Click the icon and select Create Workflow.

   • Method 2: In the left-side navigation pane, right-click the Workflow folder and select Create Workflow.

3. Configure the parameters for the business process.

   Configuration	Description
   Workflow Name	Enter a custom name based on your business scenario. This example creates a business process named DataService.
   API grouping	Select an API group to manage your APIs. This example uses the Workshop group created in Step 2. Note An API group is a collection of APIs for a specific feature or scenario and the smallest unit for API management in API Gateway. If you need to create a new group, see Step 2: Create an API group.

4. Click Determine to create the business process.

   After the business process is created, you can view it in the left-side navigation pane of the DataService Studio page.

Step 4: Generate an API

After you create a business process, you can create APIs within it.

1. Generate an API.

   On the Data Services > Service Development page, generate an API in one of the following ways:

   • Method 1: Click the icon and choose Create API > Generate API.

   • Method 2: In the left-side navigation pane, right-click the destination business process and choose Create > API > Generate API.

2. Define the API properties.

   In the Generate API dialog box, configure the API information. The following table describes the main parameters.

   Configuration Item	Description
   Location	The directory within the business process where the API is stored. Important We recommend selecting the destination folder first. If you cannot select one, create a business process first.
   API Mode	Select the mode to create the API. You can choose the codeless UI or the code editor. Codeless UI: Quickly configure a data API without writing code. Code editor: Supports advanced features such as table joins, complex queries, and aggregate functions. You can write custom SQL queries for the API to meet advanced query requirements. This topic uses the codeless UI as an example. For details about both modes, see Overview of API generation.
   API Name	Enter a custom name for the API. This topic uses rpt_user_info_all_d as an example.
   APIPath	The storage path of the API. This is the URI of the request relative to the service host. This path is used to construct the API call address. This topic uses /user as an example.
   Protocol	HTTP and HTTPS are supported. To call the API over HTTPS, bind an independent domain name and upload an SSL Certificate in the API Gateway console after you publish the API to the gateway. For more information, see Support for HTTPS.
   Request Method	GET and POST are supported. Note If you select GET as the request method, you can only set the Request Parameters of a Parameter Position to QUERY. If you select POST as the request method, you can set the Request Parameters of a Parameter Position to QUERY or BODY.
   Response Type	Only JSON is supported.
   Visible Scope	The visibility of the API after creation. Options are Work space and Private. Work space: The API is visible to all members in the current workspace. Private: The API is visible only to the API owner. Authorization is not supported. This example sets the visible scope to Work space.

3. Configure the API parameters.

   On the API editing page, configure the following parameters.

   1. Select the data source for the API.

      In the Table area, select the data source table for generating the API.

      Parameter	Description
      Data Source Type	Select the type of data source from which to create the API. This topic uses MySQL as an example.
      Data Source Name	Select the specific data source of the chosen type to generate the API from. This example uses the rds_workshop_log data source created in Step 1: Create a data source and configure network connectivity.
      Data Source Environment	Workspaces in standard mode allow access to data sources in either the development or production environment. For more information about the differences between the two environments, see Differences between workspace modes. This example selects the Production Environment.
      Data Table Name	Select the data table in the data source from which to generate the API. This topic uses the rpt_user_info_all_d table in the rds_workshop_log data source as an example.

   2. Define the request and response parameters.

      After you select a table, its fields appear in the Select Parameters area. You can then choose the fields to use as request and response parameters. To sort the fields, add the target fields to the Sort field area and adjust their order.

      In this example, the request parameter is uid, and the response parameters are all fields in the table.

      Note

      In the right-side navigation pane, click Request Parameters or Response Parameters to modify parameter settings, such as field type, sample value, and default value. Configure these settings based on your actual needs.

4. Configure the API resource group.

   On the API editing page, click Resource Group for DataService Studio on the right to configure the resource group. Because the default public resource group for DataService Studio is being discontinued, new APIs must use an exclusive service resource group. Select either a Serverless resource group (recommended) with a configured quota for DataService Studio, or an exclusive resource group for DataService Studio.

Step 5: Test the API

You must test an API before it can be published. After the API is generated, click Test in the upper-right corner of the API editing page to verify that the request and response are as expected. This example sets the value of the uid request parameter to 0016359810821 to test the result. For more information about testing, see Test an API.

Step 6: Publish the API

An API that passes testing must be published before other services can call it. In the upper-right corner of the API editing page, click Submission and select the version to publish. For more information, see Test, publish, and manage API versions.

Step 7: Call the API

The following authentication methods are supported for calling APIs:

• Simple Authentication: Low security. Suitable for scenarios such as reports and data dashboards.

• Encrypted Signature Authentication: High security. Suitable for application development scenarios.

1. In the top menu bar of DataService Studio, click Service Management to go to the service management page.

2. In the left-side navigation pane, select Call APIs.

   Published APIs are available in API Gateway. You can call the API using an API Gateway SDK. For more information, see Examples of calling an API from a client.

Step 8: View and manage APIs

On the Service Management page, you can view published APIs and perform operations such as unpublishing, authorization, and viewing call details.