Corporate security regulations prohibit direct connections to the business database. Code development interfaces are inefficient, and manual data transfer is prone to errors.
The lack of a secure data-sharing mechanism, coupled with the increase in data users, leads to IT's tendency to duplicate efforts.
Data Service supports data sharing, allowing processed and integrated data to be packaged and published as standardized APIs for external systems to call, thus achieving data value output and openly sharing.
Data Service can only be used by independently deployed FineDataLink currently.
For details about the data sources supported by FineDataLink's Data Service, see Data Sources Supported by Data Service.
To create an API using FineDataLink's Data Service function, you need to register relevant function nodes. For details, see Registration Introduction.
Non-super admin users who want to use this function need to be assigned Data Service Management Permission.
Connectivity Check:
When an API call request is initiated, the request is sent to the server of Data Service and further forwarded to the data source for data query, so it is necessary to ensure that the corresponding data source and the network where it is located can be accessed. Data Service should be used on the premise that network connectivity has been ensured. If the network is blocked, the API call request cannot be executed. You can set Blacklist and Whitelist Configuration for control.
The operation processes of using FineDataLink's Data Service for API publishing are as follows.
1. For details about the data sources supported by Data Service, see Data Sources Supported by Data Service.
2. Before creating a new API in Data Service, you need to connect the database containing the processed data that needs to be published to FineDataLink. This allows you to control the data to be published by selecting the data source name during the API publishing configuration process. For details, see Data Source Creation and Management.
Step Two: Publish an API.
There are three steps to publish an API in FDL: filling in API information, setting publishing contents and parameters, and conducting a previewing test. For details, see Overview of Publishing an API.
You can publish APIs containing parameters, as shown in the following example:
More Knowledge:
API Publication - Multi-value Query
API Publication - Query NULL Values
API Publication - Query All When the Parameter Is Empty
Step Three: Bind the API to the application.
After publishing the API, you need to bind it to the application to obtain the authentication required for external system calls. This ensures that the published API is safer when being called by external systems. For details, see Binding API to Application.
You can also bind the API to the application in step two "Publish an API."
In this step, you can:
Export the API document in the application and provide it to the caller for their reference.
1. Data Service supports the use of simple authentication and encrypted authentication for calling an API. You can choose one based on your needs. For details, see Digest Signature Authentication Method.
2. Setting the blacklist and whitelist can ensure that the published API is safer when it is called by external systems. For details, see API Blacklist and Whitelist Configuration.
Other Descriptions:
Manage and monitor API tasks, view the running status and API calls., and bring APIs online and offline in batches. For details, see Service O&M.
1. API tasks and Data Service applications cannot be edited by multiple users simultaneously in FineDataLink 4.1.6.3 and later versions.
2. You can restore and manage deleted tasks in Recycle Bin in FineDataLink 4.1.9.3 and later versions.
You need to acquire complete information for the API you intend to call, including the full path, parameters, authentication details, and so on.
There are two options:
Option One: For FineDataLink 4.1.6.4 and later versions, find the person with application permissions of binding the API, and have them export the API documentation. Use this documentation to call the API.
Option Two: Request management permissions for the API from the admin to view the API details on your own.
Step Two: Use the API.
Use the published API.
For details, see:
Use an API published by Data Service. (GET request)
Use an API published by Data Service. (POST application/JSON request)
Use an API published by Data Service. (POST x-www-form-urlencoded request)
1. Upgrade FineDataLink 4.0.24 and previous versions to the 4.0.28 version:
For API publishers, you need to recreate your existing APIs or complete the migration using our custom scripts.
For API callers, since the application ID path has been added, you need to manually modify the API access URL during calls.
If parameters were set for the API before the upgrade, the system would automatically add single quotes around parameter values when sending them. After the upgrade, what you see is what is sent, and single quotes will not be automatically added. You may need to adjust the published SQL or the parameter passing method.
2. Upgrade FineDataLink 4.0.26 and later versions to the 4.0.28 version:
To contact our technical support, you can send an email to international@fanruan.com or click at https://intl.finebi.com/.
If you cannot call the API published by FineDataLink's Data Service due to cross-domain issues, you can modify the FineDataLink server directory %tomcat%.../conf/web.xml and delete the OPTIONS configuration, as shown in the image below and restart the project.
Different Item
Function Description
The API Output operator can call business system APIs to modify data in the business system.
For understanding, see examples of Updating Event Schedule Information to WeCom Calendar and Adding/Modifying YiDA Table Data.
Encapsulate processed data into standardized APIs for external systems to call.
Data Service generates an API that can be called by external systems.
滑鼠選中內容，快速回饋問題
滑鼠選中存在疑惑的內容，即可快速回饋問題，我們將會跟進處理。
不再提示
10s後關閉
Submitted successfully
Network busy