API Key

Path: Application Forms > API Key

API Key allows you to request an API key for clients.

If the API Portal is unavailable, you can submit the request here. The application must go through a review process before it becomes effective.

Search Client

Enter the keyword to search for the desired clients.

Apply for API Key

In this section, you can find instructions on how to apply for API Key for this client.

1. Search for the client to add the API key first, and click on theicon to access the API ID list page.

1. If the client has not applied for an API key, a prompt displaying “1298 - No information found” will pop up. Click OK to exit and proceed.

2. Click Apply to access the API key application page.

• Effective Date*: The date from which the API can be used.

• API Key Name*: Application name and usage.

• Expiry Date*: The date until which the API remains valid.

• Use Quota (-1 = unlimited)*: The number of times this API can be used; -1 means unlimited.

• Description*: Reason for application.

• Select API*: API to apply.

1. Enter keywords in the search field of the selected API, or click on the icon to access the page of the selected API.

1. Several APIs can be selected, and Save has to be clicked when finished selecting in order for the system to carry over the selected APIs.

1. If the wrong API was selected, select the wrongfully selected API, and click Delete to remove it.

1. Click Save to submit the application.

Manage API Key Status

After the application form is approved by Applications, the approved application form can be seen. Reviewed application forms can be viewed, modified and revoked in this section.

1. To view application details, click on theicon to access the details page.

1. To modify an application, click on theicon to access the change page.

2. Modify the desired fields, and click Save to save and exit. Changes will appear in Applications, and the form can be updated again before submission for review.

1. To revoke an application, click on the icon to access the revoke page.

2. Modify the desired fields, and click Save to save and exit. Changes will appear in Applications, and the form can be updated again before submission for review.