Type | Supported Version |
REST API | All Versions (HTTP/HTTPS) |
Capability | System Support | Description |
Offline sync (read/write) | ✓ / - | Supports reading data as a source for offline synchronization tasks. The DataBuddy data source supports only read access and does not support writes. |
Limit | Description |
Response Format | JSON format data must be returned. |
Authentication Method | Supports no authentication / Basic / Token / OAuth2 password mode / OAuth2 client mode |
Authentication Method | Description |
No Authentication | The API does not require authentication. |
Basic | Username + Password |
Token | Fixed Token |
OAuth2 Password Mode | Username + Password for Token Exchange |
OAuth2 Client Mode | ClientId + ClientSecret for Token Exchange |
Parameter | Description | Required | Default Value |
Data Source Name | Unique identifier of the data source within the workspace | Yes | - |
Request URL | Complete API URL | Yes | - |
Authentication Method | No authentication / Basic / Token / OAuth2 password mode / OAuth2 client mode | Yes | No Authentication |
Username / Password | Account for Basic or OAuth2 password mode | Required for the corresponding authentication method | - |
Token | Fixed token for Token authentication | Required when the authentication method is Token | - |
ClientId / ClientSecret | Credentials for OAuth2 client mode | Required when the authentication method is OAuth2 client mode | - |
Token Endpoint / Scope | Token endpoint and scope in OAuth2 mode | Required for OAuth2 authentication | - |
Configuration Item | Description |
Source Connection | A configured REST API data source. Required. Click Test to verify connectivity. |
Read Method | Parse data: Parse the JSON content returned by the API and write it to the target table based on field mappings. Raw file: Do not parse the response content. Write the raw data returned by the API to the target as a whole. For regular structured data ingestion, select Parse data. |
Request method | HTTP method of the API, POST / GET |
Returned data type | Data format of the API response. Currently, JSON is supported. |
JSON data path | Use JSONPath to locate the level where records reside in the response, for example, $.data.list. It must point to an array of records or a single record object. After configuration, the source field JSONPath in field mapping uses a single record as the root node. |
Returned data structure | Single record: The response is a single JSON object. Array: The response is an array of JSON objects, with each element representing a record. Note that in array mode, each record must be a JSON object. A two-dimensional array will cause parsing to fail. |
Request header. | API request headers. Fill them in as prompted on the page, for example, {"Accept-Language":"zh-cn"}. If authentication information is required, such as Authorization, enter it here as well. |
Request parameters. | Optional. For GET requests, enter the query parameters appended to the URL, for example, name=wedata&age=10. For POST requests, enter the request body parameters. |
Advanced Settings | Click Settings to configure advanced parameters. The default settings meet general scenarios. For large data volumes, split the data into multiple tasks based on the API query parameters and read them separately. |
Practice | Recommendation |
Authentication Security | Prioritize OAuth2 and avoid plaintext passwords. |
Pagination Handling | Confirm the API pagination mechanism to avoid data omission. |
Rate Limiting Control | Set request frequency appropriately to avoid triggering API rate limiting. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários