All Products
Search
Document Center

IoT Platform:Configure an API data source

Last Updated:Oct 31, 2024

IoT Platform allows you to call an API operation to import third-party data. If data is imported to IoT Platform by calling an API operation, the data is called data of API data sources. You can import data from on-premises servers or other third-party platforms to IoT Platform data services for data analysis and processing. This topic describes how to configure an API data source.

Prerequisites

An IoT Platform Enterprise Edition instance is purchased. For more information, see Purchase Enterprise Edition instances.

Procedure

  1. In the IoT Platform console, click Overview. On the Overview tab, find the instance that you want to manage and click the instance ID or the instance name.

  2. In the left-side navigation pane, choose Data Service > Data Access. On the Data Access page, click API.

  3. On the API tab, click Create API Data Source.

  4. In the Create API Data Source dialog box, configure the parameters and click OK. The following table describes the parameters.

    Parameter

    Description

    API Data Source Name

    The name of the API data source. The name can contain letters, digits, underscores (_), and parentheses (). The name cannot exceed 30 characters in length.

    Description

    The description of the API data source. The description cannot exceed 100 characters in length.

    Export Data to Custom Storage Table

    • Yes (Select Custom Storage Table)

      Note

      After you bind a custom storage table, you cannot use a data parsing task to write data to the table.

    • No (Data Parsing Required)

    Custom Storage Table

    If you set the Export Data to Custom Storage Table parameter to Yes (Select Custom Storage Table), you must select a custom storage table.

    Note

    You cannot select custom storage tables that are not initialized or are in use.

  5. On the API tab, find the API data source that you created and click Debugging in the Actions column. You are redirected to the configuration page of the AddDataForApiSource operation in the OpenAPI Explorer console. You can call the AddDataForApiSource operation to import third-party data to IoT Platform. Data that is imported to IoT Platform by calling the AddDataForApiSource operation is called data of API data sources. On the SDK Sample Code tab, click SDK Information. The SDK Information panel displays information about the corresponding SDK, including the SDK name and the SDK package version.

Optional operations

After you create an API data source, go to the API tab, find the API data source that you created, and then click Edit or Delete in the Actions column to perform the corresponding operation on the API data source.

Operation

Description

Edit

Modify the API data source. You can modify all parameters of the API data source.

Delete

Delete the API data source.

Important

If you delete an API data source that is specified as a source node for a data parsing task, the source node of the data parsing task is also deleted. Proceed with caution.

What to do next

After you create an API data source, you can use the data parsing feature to process, analyze, and utilize the data of the API data source. For more information, see Data parsing overview.