Dataphin:Call API

Prerequisites

• The API is published to the Data Service marketplace. For more information, see Test and publish an API.

• You need to create an application first. For more information, see Create an application.

API documentation entry description

• Access API documentation from the marketplace: In the top menu bar, click Service > API Marketplace. In the navigation pane on the left, click the API tab. In the Documentation column for the target API, click API Documentation to open the API Documentation page for the production environment. You can view and download the API documentation regardless of your permissions.

• Access API documentation from Application Management: You can use this method only if the API is authorized for an application and you have the necessary permissions. In the top menu bar, click Service > Application Management. In the navigation pane on the left, choose Service Management > Authorized API Services. In the Actions column for the target API, click View to open the API Documentation page. This opens the API documentation for the development environment. You can switch environments and download the API documentation.

Operations at the top of the API documentation and debugging page

• Switch API: You can switch APIs to view in the upper-left corner of the page. You can search for APIs by name or ID using fuzzy search. The system supports searching for published APIs in the service projects that the current user has joined. The system will recommend the 9 most recent APIs for you.

• Switch API Runtime Environment:

  • API Documentation: From the Application Management > Authorized API Services page, you can select an environment (development environment or production environment) to view its API documentation, provided you have the required permissions. When the runtime environment is the development environment, the list of common request parameters includes the apiVersion parameter.

  • Debug API: You can select environments (development environment, production environment) for which you have permissions to debug the API. When the runtime environment is the development environment, the development data source is used for debugging. When the runtime environment is the production environment, the production data source is used for debugging.

    Note

    • When the runtime environment is the development environment, for combination APIs, sub-APIs configured in Dev-Prod mode use the development environment data source for debugging, while sub-APIs configured in Basic mode use the production environment data source for debugging.

    • When the runtime environment is the production environment, for combination APIs, sub-APIs configured in either Dev-Prod mode or Basic mode use the production environment data source for debugging.

• Switch API Version: When the runtime environment is the development environment, you can switch API versions in the upper-right corner of the page when debugging an API. You can only select submitted versions (including published versions).

Step 1: Query and request an API

1. In the top menu bar of the Dataphin homepage, choose Service > API Marketplace.

2. Click the API tab, and then click Documentation column of the target API under API Documentation to go to the API Documentation page. This method accesses the API documentation in the production environment. The path may vary depending on whether the API is published. For more information, see API documentation entry description.

3. On the API Documentation page, check the API's Basic Information, Sort Settings (only supported for service unit APIs in codeless UI mode), Business Request Parameter List, Common Request Parameter List, Row-Level Permission List, Response Parameter List, and JSON Response Example to determine whether they meet your business requirements.

   Note

   • When the API type is Direct Data Source API, Service Unit API, or Combination API and row-level permission is enabled, you can view the row-level permission list information.

   • When the call mode is asynchronous invocation, API data caching is not supported. Data can be incrementally obtained through cursors. Therefore, asynchronous invocation does not require cache and result paging configurations, and the common request parameters do not display PageSize and PageStart information.

4. After confirming that the current API meets your business requirements, click Request Status column under Request Now on the API Service page. You will be redirected to the Management Hub > Permission Management > My Permissions > Data Service Permissions page to request permissions for the API. For more information, see Request API permissions.

Step 2: Debug the API

After you complete the API permission request, you can debug the API to verify that it works properly.

1. In the top menu bar, click Application Management.

2. In the navigation pane on the left, choose Service Management > Authorized API Services. On the Authorized API Services page, in the Actions column for the target API, click Debug to open the API Debugging page.

3. On the API Debugging page, configure the debug input values. For more information about debugging parameters and testing whether the API meets your expectations, see Step 1: Test the API.

   You can view the domain name at the top of the API debugging page. This domain name is only used for internal testing. For the actual domain name to call, see View domain name.

   In the API Debugging page's Optional Response Parameter List section, you can quickly switch between authorized applications in the upper-right corner.

Step 3: Download documentation

You can download API documentation to share with other developers, increasing flexibility of use. You can download the documentation in Word format for easy editing, or as an OpenAPI specification YAML document for Alibaba Cloud Model Studio plugin registration.

API call templates

1. On the DataService Studio page, click Application Management in the menu bar. In the navigation pane on the left, click Call Instructions.

2. On the Call Instructions page, click the API Call Instructions tab to go to the API Call Instructions page.

3. On the API Call Instructions page, view the templates for API call examples and perform the following operations.

   • Download Default Call Examples: You can click Download Default Call Examples to download API call examples, including synchronous and asynchronous calls.

   • Download Python Call Examples: To call APIs using Python, click Download Python Call Examples to download a compressed file of Python examples.

   • Download Java SDK: To call APIs using the Java SDK, click Download Java SDK to download the Java SDK code package.

   • Manage SDKs And Call Examples: Click the Manage SDKs And Call Examples button to go to the Manage SDKs and Call Examples page, where you can centrally manage API call examples, add new call examples, or sort call examples.

     • Add: Click the Add button at the bottom to add a call example.

       • Name: Enter a name for the call example, which will be displayed on the API Call Instructions page. The name must be unique. We recommend that you enter no more than 10 characters, with a maximum of 50 characters.

       • Description: Enter a brief description of the call example to help relevant business personnel understand its purpose. Maximum 100 characters.

       • Upload File: Click the Upload button to select a file from your local computer and upload it to Dataphin. Supported file formats include zip, rar, doc, docx, PDF, and jpg, with a maximum file size of 200 MB.

         You can download the file to your local computer.

       • Display: Determines whether the call example is visible on the API Call Instructions page. After saving, this option is enabled by default. You can disable the call example.

       • Save: Save the modified or newly added call example.

       • Edit/Delete: Modify or delete the configuration information of custom call examples.

     • Sort: Click Sort, drag the call examples to sort them, and click the Complete button in the upper-right corner to complete the sorting. The sort order here will affect the default display order on the API Call Instructions page.

       Note

       • You can create up to 10 API call examples (including the call examples provided by the system by default).

       • The call examples provided by the system by default cannot be edited or deleted, but you can choose whether to display them.

   • Edit Call Instructions: Modify the API call instructions based on your business scenarios.

4. Call the API according to the call example instructions.

API return record limits

After you call an API, you can query data. For synchronous calls, a maximum of 10,000 records can be returned per query. For both synchronous and asynchronous calls, there is no limit on the total number of records that you can query.