API List

Path: API Management > API List

All APIs on the system are listed here. You can view API details, test APIs, and configure whether registered or designed APIs are enabled.

Import APIs

1. Click Import API first to access the import page, click on the icon and upload the API to import.

1. Select a single JSON file to upload at a time, and click Upload.

1. The uploaded APIs will be displayed in the table below. Check to select the APIs for import, and click Import to upload them to the system.

Search APIs

Keyword Search

Under the Keyword Search tab, 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.

1. Click the Search By Label tab.

1. Enter the keyword in the Label field, check to select the desired labels from the suggestions, and click Search to proceed.

1. The APIs match the label will be displayed.

Switch View Modes

In this section, you can find instructions on how to view APIs using Manage View and Audit View. The default mode is Manage View.

Manage View

Manage View displays API attributes for managing purposes.

1. Click on the icon.

1. Select Manage View, and the icon changes to .

1. View the API in Manage View.

Audit Mode

Audit View displays API audit details, including the creator, creation time, last updated user, and last updated time for auditing purposes.

1. Click on the icon.

1. Select Audit View, and the icon changes to .

1. View the API in Audit View.

View APIs

Search for the API to view details, and click on theicon to access the API details page.

Update APIs

Search for the API to modify, and click on the icon to access the update page to proceed. The update details will vary according to different API sources.

1. If the source is an API combination, upon accessing the update page, you will see the Open Composer button.

1. Click Open Composer to access the API Composer page.

1. If the API source is registered, click on theicon to update it, but there will be no Open Composer button.

2. Modify the desired fields, and click Update to save and exit.

1. 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 System Configs > 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*: The source URL can only be modified for registered APIs; it cannot be changed for composite APIs.

  • For registered APIs, 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 composite 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 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.

• Description: Other descriptions of the API.

• Label: Fill in the desired text and click the ENTER key to create the label, with a limit of up to five labels allowed. Labels with capitalized characters will automatically be converted to lowercase, and each label can be no more than 20 characters long.

Test APIs

1. Search for the API to test, and click on the icon to access the API Test page.

1. Confirm the digiRunner URL and Http Methods fields, select the Authorization test method, and click Test to test whether this API can be used.

1. If the result is Status 200 and there were data in Headers and Body, it means that this API is normal and can be used.

Enable/Disable APIs

The APIs registered in the system are disabled () by default, and must be manually enabled before they can be used.

Enable/Disable APIs Immediately

1. Search for and check the APIs to enable, and click Enable to bring up the Scheduled Activation Date dialog.

1. Ensure API status is set to Enable, leave the date input box blank, and click Confirm to activate the API immediately. Once activated, the API status will change to .

1. Search for and check the APIs to disable, and click Disable to bring up the Scheduled Deactivation Date dialog.

1. Ensure API status is set to Disable, leave the date input box blank, and click Confirm to deactivate the API immediately. Once deactivated, the API status will change to .

Enable/Disable APIs on Schedule

1. Search for and check the APIs to schedule for activation, and click Enable to bring up the Scheduled Activation Date dialog.

1. Ensure API status is set to Enable, select the scheduled activation date, and click Confirm to schedule the API activation.

1. The configured API will be enabled on the scheduled date.

1. To schedule a deactivation date, check the desired APIs and click Disable to bring up the Scheduled Deactivation Date dialog.

1. Set API status to Disable, select the scheduled deactivation date, and click Confirm to schedule the API deactivation.

1. The configured API will be disabled on the scheduled date.

1. You can schedule both the enablement and disablement of the same API.

Cancel Schedules

1. Search for and check the APIs to cancel the scheduled activation, and click Cancel Scheduled Date to proceed.

1. Set API status to Revoke Scheduled Enable Date, and click Confirm to cancel scheduled activation.

1. The scheduled API activation has been canceled.

1. Search for and check the APIs to cancel the scheduled deactivation, and click Cancel Scheduled Date to proceed.

1. Set API status to Revoke Scheduled Disable Date, and click Confirm to cancel scheduled deactivation.

1. The scheduled API deactivation has been canceled.

1. Search for and check the APIs to cancel the scheduled activation and deactivation, and click Cancel Scheduled Date to proceed.

1. Set API status to Revoke Scheduled Date, and click Confirm to cancel scheduled activation and deactivation.

1. The scheduled API activation and deactivation have been canceled.

Delete APIs

1. Search for the API to delete, and click Delete to proceed.

1. A warning prompt displaying the message “Confirm Delete?” will pop up. Click Confirm to delete this API and exit.

JWT Settings

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.

Whether JWS or JWE was selected for Request, its background color is orange , and the background color of Response is blue .

Export APIs

1. To export registered and combined APIs, search for the API to export, and click Export to proceed.

1. A warning prompt displaying the message “Confirm Export?” will pop up. Click Confirm to download the json file.

Swagger

1. Click on theicon to access the Swagger page.

1. Copy the text on the Swagger page to Swagger.io to display its information.