Connector
Before starting to handle integration transactions, you need to clearly define the resources that can be integrated. After the resource definition is completed, you can proceed with the orchestration of integrated data, as shown in the figure:

Integration refers to the connection between platform applications and external systems, while internal applications within the platform interact directly through internal service calls. As an important part of integration, connectors cover three types of resources: applications, databases, and file sets.
- Application: Refers to the application resources that can be integrated.
- Database: Refers to the database resources that can be integrated.
- File Set: Refers to the file resources that can be referenced.

In the connector, the component list is presented in the form of cards. You can preview the basic information of applications, databases, or file sets on the cards:
- Application: Icon, name, business domain, description, authorization status, and the number of included APIs.
Note
When a certain authentication method is selected during application creation, the authorization status here will correspond to the status.

- Database: Name, type, description, and the number of included APIs.

- File Set: Name, type, description, and the number of included files.

I. Switch Resource Types
1. Function Introduction
The connector contains three major resource types: applications, databases, and file sets. You can independently manage and operate these three types of resources.
2. Operation Method
Click the corresponding resource type in the Tab bar to switch.

II. Filtering
1. Function Introduction
According to actual business needs, you can customize the filtering conditions for applications, databases, and file sets. Under the current filtering conditions, the corresponding lists of applications, databases, and file sets will be displayed, which is convenient for viewing and editing different applications, databases, and file sets.
2. Operation Method
- Filtering: Enter the conditions in the filtering area and click the "Search" button to filter applications, databases, and file sets.
- One-Click Clear: Click the "Clear" icon to clear all the conditions in the current filtering area at once.



III. New Addition
1. Function Introduction
It supports customizing application, database, and file set resources.
- Application: You can set the application's name, description, icon, business domain, server address, authentication method, and encryption method.
- Database: You can set the database's type, name, description, connection address, port, extended parameters, source database name, account, and password.
- File Set: You can set the file set's name, type, and description.
Note
Database resources can include operation resources such as queries, inserts, updates, and deletes, but DDL execution is not allowed.
Tip
After filling in the database information, you can test its connection. Even if the current connection fails or the connection is not tested, the connection can still be successfully created.
2. Operation Method
- Application: Click the "New Application Resource" button, fill in the information according to your needs on the pop-up page, and then save to create it successfully.

- Database: Click the "New DB Resource" button, fill in the information according to your needs on the pop-up page, and then save to create it successfully.

- File Set: Click the "New File Set" button, fill in the information according to your needs on the pop-up page, and then save to create it successfully.

IV. Editing
1. Function Introduction
Successfully created applications, databases, and file sets can be edited.
2. Operation Method
Click the "Edit" button, and you can edit on the pop-up editing page (the same applies to databases and file sets as shown here for applications).

V. View References
1. Function Introduction
You can view various elements that have reference relationships with the application, database, or file set.
2. Operation Method
Click the "View References" icon to view the reference information. (The same applies to databases and file sets as shown here for applications).

VI. Deletion
1. Function Introduction
When an application, database, or file set is no longer in use, you can choose to delete it.
Note
Before deletion, ensure that the application, database, or file set is not being referenced; otherwise, the deletion operation will fail.
Warning
Once an application, database, or file set is deleted, it cannot be recovered. Please operate with caution!
2. Operation Method
Click the "Delete" icon, confirm the deletion, and it will be deleted. (The same applies to databases and file sets as shown here for applications).

VII. Details
1. Function Introduction
An application or database can contain multiple APIs, and a file set can contain multiple files, but not all of them can be presented on the card. To understand applications, databases, and file sets more comprehensively, you can view their details, including browsing the basic information of applications, databases, and file sets, as well as the information of all the included APIs and files.
Note
If a certain authentication method is selected during application creation, you can add its authorization information in the details.
2. Operation Method
Click the card to enter its details page (the same applies to databases and file sets as shown here for applications).

VIII. Manage APIs
After entering the details page, you can manage the included APIs and files, including operations such as addition, deletion, and editing.
(I) Query
1. Function Introduction
According to actual business needs, you can customize the filtering conditions for APIs or files. Under the set filtering conditions, the corresponding lists of APIs or files will be displayed.
2. Operation Method
Select or enter conditions in the filtering area to filter APIs or files (the same applies to databases and file sets as shown here for applications).

(II) New Addition
1. Function Introduction
Applications can add new APIs or WebServices according to business needs, databases can add new APIs, and file sets can add new files.
- New API: You can set the basic information of the API, request parameters, and response results.
- API URL support:
- Protocol type: HTTP/HTTPS
- Verb: GET, POST, PUT, DELETE
- Parameter type support: Long, Double, String, Boolean, Integer, Date, Void, Object.
- Content types supported: application/json, x-www-form-urlencoded, multipart/form-data, application/json + fhir
- API URL support:
- New WebService: You can set the basic information of the WebService, request parameters, and response results (not supported for databases).
- API URL support:
- Protocol type: HTTP/HTTPS
- Verb: POST
- Parameter type support: Long, Double, String, Boolean, Integer, Date, Void, Object.
- API URL support:
Note
If the "Ignore Log Frequency Configuration" switch is not enabled, the system will only record part of the log content. Under normal operation, you can turn off this configuration to save resources. If a problem occurs during operation, you can turn on this configuration, and the system will completely record the detailed request and response information of the interface logs, which is convenient for troubleshooting and viewing.
Note
The paths of APIs are not allowed to be repeated.
- New File: You can upload local files, set their names and descriptions, and preview the existing data in the uploaded files.
Note
Supported file formats for upload are xlsx, xls, csv, and the file size should be less than 50M.
2. Operation Method
- For applications, click the "New API" button, select "New API" or "New WebService", fill in the information on the pop-up page, and then save to add it successfully.
- For databases, click the "New API" button, fill in the information on the pop-up page, and then save to add it successfully.
- For file sets, click the "New File" button, fill in the information on the pop-up page, and then save to add it successfully.
After successful creation, the APIs and files will be automatically enabled. The enabled APIs and files can be referenced.

(III) Editing
1. Function Introduction
Successfully created APIs or files can be edited.
2. Operation Method
Click the "Edit" button, and you can edit on the pop-up editing page.
Note
Editing operations are only allowed when APIs and files are in the disabled state. Once APIs and files are enabled, the edit button will be hidden to prevent improper modifications to the APIs and files in use.

(IV) Details
1. Function Introduction
It supports displaying the detailed information of APIs and files.
2. Operation Method
Click the "Details" button to view the detailed information of the selected API or file.

(V) Copy
1. Function Introduction
When the API information has a high degree of similarity, you can use the copy function to generate a new page named "Original API Name - Copy". Edit the content and save it to successfully copy (not supported for databases and file sets).
Note
The paths of APIs are not allowed to be repeated.
2. Operation Method
Click the "Copy" button, fill in the information on the pop-up page, and then save to copy successfully.
Note
When an API is not enabled, the "Edit" button will be displayed in the operation bar, and the "Copy" option will be hidden under the "More" menu.

(VI) Deletion
1. Function Introduction
When an API or file is no longer in use, you can choose to delete it.
Note
APIs and files that are being referenced cannot be deleted.
Warning
Once an API is deleted, it cannot be recovered. Please operate with caution!
2. Operation Method
Click the "Delete" icon, confirm the deletion, and it will be deleted.

(VII) Publish Open APIs
1. Function Introduction
It supports publishing APIs in applications and databases as open APIs. After being set as open APIs, they can be used by external systems.
Note
APIs set as open APIs can be viewed in the "Open Platform".
2. Operation Method
Select an API and click the "Publish Open API" button to publish it successfully.

(VIII) Export API Documentation
1. Function Introduction
It supports exporting API information as documentation.
2. Operation Method
Select an API and click the "Export API Documentation" button to export it successfully.
Tip
The successfully exported documentation can be downloaded in "Files" - "Export Tasks".
