API List
Was this helpful?
Was this helpful?
Path: API Management > API List
All APIs on the system will be placed in the API list; API related information will be displayed here, and APIs can also be tested here. Whether to enable registered or designed APIs is also set here.
In this section, you can find instructions on how to import registered/combined APIs.
JSON files can be uploaded; after selecting the file, click Upload.
Only one file can be uploaded each time.
Uploaded API will be displayed in the table below; however, no APIs were uploaded to the system yet at this time. First, select the APIs to import, and click Import.
Search: Enter the keyword and click Search to search for desired APIs.
Search By label: The Search By label feature is independent, and will not be affected by the basic keyword search or API sources.
Enter the keyword, click Search By label, and the Label List will pop up.
Check the desired label, and click Confirm. The APIs match the label will be displayed.
The information in Details can only be viewed and not edited.
If the source is an API combination, upon accessing the update page, you will see the Open Composer button.
Click Open Composer to access the API Composer page.
Modify the desired fields, and click Update to save and exit.
Fill in the data or make selections as instructed below. The fields marked with “*” are required.
[Module ID] API Module*: The API number and name cannot be changed.
API Cache*: Options include None / Auto / Fixed. If enabled, the number of calls made to endpoints can be reduced, and API request delays can be improved.
API ID*: ID of the API; cannot be changed.
API Name*: Able to rename the API
Fixed Cache Time(Minute)*: The duration for which data is retained in the cache. This field is only applicable when the API Cache is set to Fixed. If the fixed time is set to 0, the value from FIXED_CACHE_TIME will be fetched; otherwise, the value specified in the fixed cache time will be used. FIXED_CACHE_TIME can be configured in Setting > FIXED_CACHE_TIME.
API status*: Enables or disables API operations.
JWT Settings: Set whether to use JWE or JWS encryption for Request / Response.
Http Methods*: Set the Http Methods of this API.
Data Format: Specifies the format of this API (SOAP / JSON / XML).
Target URL*: For registered APIs only, if the source URL has been changed, the new URL can be specified here.
Check Source IP Diversion to configure the source IP for more effective management and control of network traffic. For registered APIs, only No Auth is available, while combination APIs can select either Path Parameter or No Auth.
Path Parameter: Upon checking, carries over the URL Path parameter data when calling APIs.
No Auth: Upon checking, allows calling the API without OAuth authentication, commonly used for Public APIs.
API Log Header Mask: Specifies masking for the Header field, applicable only to registered APIs.
For example, if the value is Hello, with a character count of 1 and masking character #, the following will be displayed:
Policy 0: No masking, displays Hello.
Policy 1: Retains the first and last character, displays H###o.
Policy 2: Retains the first character, displays H####.
Policy 3: Retains the last character, displays ####o.
API Log Body Mask Policy: Specifies different masking strategies for keywords in the Body content, applicable only to registered APIs.
For example, if the original text, "name":"test","id":"1", with a character count of 2, masking character #, and keyword name, the following will be displayed:
Policy 0: No masking, displays "name":"test","id":"1".
Policy 1: Masks the first and last 2 characters, displays "#name##"test","id":"1".
Policy 2: Masks the first 2 characters, displays "#name":"test","id":"1".
Policy 3: Masks the last 2 characters, displays "#name##"test","id":"1".
Policy 4 uses regular expressions for definition. For example, with a character count of 1 and a mask of #, and a regular expression of name\d, the following will be displayed:
"name1":"test","id":"1" will display as "name1#:"test","id":"1".
"name2":"test","id":"1" will display as "name2#:"test","id":"1".
"name-3":"test","id":"1" will display as "name-3:"test","id":"1".
Fail Discovery Policy*: Specifies the action to take when an API connection fails. The system default is set to When the connection fails or the HTTP status code is 4xx (client error) or 5xx (server error).
Fail Discovery Policy is only available on dgrc.
Fail Handle Policy*: Specifies how the system handles API connection failures. Choose between No retries or When calling the target URL fails, automatically retry the next target URL.
Fail Handle Policy is only available on dgrc.
Description: Other descriptions of the API.
Label: Up to five labels can be used. Labels with capitalized characters will automatically be switched to lower case, and each label can be no more than 20 characters long.
The API status must be enabled.
Select the Authorization test method, for example: Client Credentials means the test can only be clicked after entering the client account and password. Confirm the digiRunner URL and Http Methods fields, then click Test to test whether this API can be used.
If the result is Status 201 and there were data in Headers and Body, it means that this API is normal and can be used.
Search for the API to delete, and click Delete to proceed.
A warning prompt displaying the message “Confirm Delete?” will pop up. Click Confirm to delete this API and exit.
The API you want to delete must be disabled and not applied by groups.
Whether to use JWT (signature) or JWE (encryption) for Request and Response. The system can perform JWT encryption (including JWE & JWS) to APIs.
JWT: JWT and JWS (body) will be called when the API is called.
JWS: Refers to signed JWT.
JWE: Refers to JWT with encrypted payloads.
To export registered and combined APIs, search for the API to export, and click Export to proceed.
A warning prompt displaying the message “Confirm Export?” will pop up. Click Confirm to download the json file.
APIs with JAVA and .NET as sources cannot be exported.
Copy the text on the Swagger page to Swagger.io to display its information.
Click Import API first to access the import page, click on the icon and upload the API to import.
Search for the API to view details, and click on theicon to access the API details page.
Search for the API to modify and click on the icon to access the update page to proceed. The API update page will vary according to different API sources.
If the API source is registered, click on theicon to update it, but there will be no Open Composer button.
Search for the API to test, and click on the icon to access the API Test page.
The APIs registered in the system are disabled () by default, and must be manually enabled before they can be used.
Search for and check the APIs to enable, and click Enable to activate the APIs. The status will change to.
Search for and check the APIs to disable, and click Disable to deactivate the APIs. The status will change to.
Whether JWS or JWE was selected for Request, its background color is orange , and the background color of Response is blue .
Click on theicon to access the Swagger page.
