Applying for API Key

For more details, please refer to "Get API Key and Call API"

1. Configure SMTP: Before applying for an API Key, complete the SMTP server setup to ensure the system can correctly send notification emails for the API Key application and approval process. Without this setup, the application may not be processed successfully.

2. Submit Application: Select a client and fill in the information to apply for an API Key.

3. Approval Process: Complete the approval workflow in digiRunner to activate the API Key. For detailed steps, refer to Approval Flow & Applications, or see the full process in this section: Obtaining API Keys and Calling APIs.

For detailed information, refer to the following sections:

• Application process: Obtaining API Keys and Calling APIs

• Feature details: API Key

Example:

Field Description:

Parameter	Type	Requirement	Description
API Key Name	String	Required	API Key name
Effective Date	Date	Required	The start date from which the API Key can be used to call APIs.
Expiry Date	Date	Required	The last date until which the API Key can be used to call APIs.
Use Quota (-1 = unlimited)	String	Required	The maximum number of API calls allowed. If the value is -1, there is no usage limit.
Description	String	Required	The purpose or usage description of the API Key.
Select API	String	Required	Check the APIs to be associated with this API Key.