Dataphin:Call API

Prerequisites

• The API has been published to DataService Studio. For more information, see Test and publish API.

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

API documentation entry instructions

• Accessing API Documentation from the Marketplace: Click Service > Marketplace on the top menu bar. Then, in the left-side navigation pane, click API Service. Next, under the API Documentation section, click the Documentation link for the desired API to navigate to the API Documentation page. This approach provides access to API documentation in the production environment and allows for viewing and downloading the documentation without regard to permissions.

• Accessing API Documentation through Invocation: Only APIs that are authorized for applications and users with the appropriate permissions can be accessed. To view the API documentation, click Service > Invocation on the top menu bar. Then, in the left-side navigation pane, select a service project and navigate to Service Invocation > Authorized API Service. Click View in the operation column for the desired API to open the API Documentation page. This approach provides access to API documentation within the development environment and supports environment switching and API documentation downloads.

Top operations on the API documentation and debugging page

• Switch API: In the upper left corner of the page, you can switch to view APIs, conduct a fuzzy search by name or ID, and find APIs published within service projects you are a member of. The system will suggest the nine most recent APIs for you.

• Switch API Running Environment:

  • API Documentation: Access to API documentation is available exclusively through the Invocation > Authorized API Service page for authorized environments, such as the development or production environment. In the development environment, the public request parameter list includes support for the apiVersion parameter.

  • Debug API: Enables API debugging in authorized environments, such as development or production. It utilizes the development data source in the development environment and the production data source in the production environment for debugging purposes.

    Note

    • When the running environment is the development environment, the sub-APIs of the composite API call use the development environment data source for debugging based on the API configuration submitted in Dev-Prod mode; the production environment data source is used for debugging based on the API configuration submitted in Basic mode.

    • When the running environment is the production environment, the sub-APIs of the composite API call use the production environment data source for debugging based on the API configuration submitted in Dev-Prod mode or Basic mode.

• Switch API Version: In the development environment, you can select a different API version from the upper right corner of the page while debugging. Only versions that have been submitted, including those that are published, are available for selection.

Step 1: Query and request API

1. On the Dataphin home page, select Service > Marketplace from the top menu bar.

2. Click API Service in the left-side navigation pane, then click the Documentation tab for the desired API under API Documentation to access the API Documentation page. This method provides access to the API documentation within the production environment. The path to the documentation may vary depending on whether the API has been published. For more information, see API documentation entry instructions.

3. On the API Documentation page, review the Basic Information, Sort Settings (supported only by the service unit API - codeless UI), Business Request Parameter List, Public Request Parameter List, Return Parameter List, and JSON Return Example to ensure they align with your business scenario.

4. After ensuring the current API suits your business scenario, click Request Now in the Request Status column on the API service page.

5. On the API Permission Request page, you can request the necessary API permissions. For detailed instructions, see Request API permissions.

Step 2: Debug API

After completing the API permission request, you can debug the API to check if it can be used normally.

1. Click Invocation on the top menu bar and select a service project.

2. In the left-side navigation pane, select Service Invocation > Authorized API Service. On the Authorized API Service page, click Debug in the operation column of the target API to access the API Debugging page.

3. On the API Debugging page, set up the debugging input values and verify that the parameter configuration and API test align with your expectations. For more information, see Step 1: Test API.

   At the top of the API debugging page, you can view the domain name used exclusively for internal testing. To see the actual domain name for invocation, refer to View domain name.

   On the API Debugging page, within the Optional Return Parameter List section, you can swiftly switch between authorized applications using the dropdown in the upper right corner.

Step 3: Download documentation

You can download the API documentation to share with other developers, enhancing flexibility. It supports downloading documents in Word format for easy modification; you can also download it as an OpenAPI specification YAML document for plug-in registration in the BaLian large model.

API invocation template

1. On the DataService Studio page, click Invocation in the top menu bar, then click Invocation Instructions in the left-side navigation pane to access the invocation instructions page.

2. On the invocation instructions page, click the API Invocation Instructions tab to access the API invocation instructions.

3. On the API Invocation Instructions page, you can view the API invocation example template, and then carry out the necessary operations.

   • Download Default Invocation Example: To download the API invocation example, click Download Default Invocation Example.

   • Download Python Invocation Example: To call the API using Python, click Download Python Invocation Example to retrieve the Python example file package.

   • Download Java SDK: To call the API using the Java SDK, click Download Java SDK to retrieve the code package.

   • Manage SDK and Invocation Examples: To access the SDK management and invocation examples page, click the Manage SDK and Invocation Examples button. Here, you can manage API invocation examples in a unified manner, including adding new examples or sorting existing ones.

     • Add: To add an invocation example, click the Add button at the bottom.

       • Name: Enter a unique name for the invocation example to be displayed on the API invocation instructions page. It is recommended to limit the name to no more than 10 characters, although the maximum allowed is 50 characters.

       • Description: Provide a concise description of the invocation example, limited to 100 characters, to assist relevant business personnel in understanding its purpose.

       • Upload File: To upload a file to Dataphin, click the Upload button, select the desired file from your local system, and proceed with the upload. The supported file formats include zip, rar, doc, docx, PDF, and jpg, and the file size must not exceed 200M.

         Supports downloading files to the local system.

       • Display: Determines the visibility of the invocation example on the API invocation instructions page. It is enabled by default after saving, but you can choose to disable it.

       • Save: Allows you to save modified or newly added invocation examples.

       • Edit/ Delete: Allows you to modify or delete custom invocation example configurations.

     • Sort: Click Sort, drag the invocation examples to reorder them, and click the Complete button in the upper right corner to finalize the sorting. The order you set will determine the default display sequence on the API Invocation Instructions page.

       Note

       • Supports creating no more than 10 API invocation examples (including system default invocation examples).

       • System default invocation examples do not support editing or deletion, but you can choose whether to display the invocation example.

   • Edit Invocation Instructions: Allows for the customization of API invocation instructions to suit specific business scenarios.

4. Invoke the API following the provided invocation example instructions.

API return count

After calling the API, you can query data. The query count supported for different service types and data sources is shown in the table below.

When calling the API through the SDK, if you need to query data from the 9000th to the 10000th record, configure the public request parameter PageStart to 9000 and PageSize to 1000.