How to Apply for and Obtain a digiRunner API Key

Q: What is the complete process for applying for, approving, and retrieving a digiRunner API Key?

(Keywords: digiRunner API Key, Application Process, API Key Approval, DGRK, API Quota, Secret Key)

A: The API Key lifecycle in digiRunner involves application submission, a multi-level approval workflow, and email issuance. Follow this step-by-step guide to successfully obtain your credentials.

Important Prerequisites:

• SMTP Configuration: Ensure your system's SMTP settings are configured before applying. Without this, the system cannot send the approval emails or the final API Key notification.

• API Registration: Only select APIs that are already "registered" in the API Management > API List.

---

1. Initiate the Application

• Navigate to the Form: Go to Application Forms > API Key in the console.

• Select Client: Search for and select your target Client.

  • Note: If you see a message saying "1298 - No information found," you can safely ignore it and proceed by clicking Apply.

• Configure Key Details: Fill in the required fields:

  • API Key Name: Assign a descriptive name.

  • Effective/Expiry Date: Define the validity period for the key.

  • Use Quota: Enter specific limits or set to -1 for unlimited usage.

• Select APIs: Click the search icon to browse registered APIs. Add the specific APIs this key should access and click Save.

2. Submit for Approval

• Submit Draft: Your saved application is stored as a draft. Navigate to Application Forms > Applications.

• Trigger Workflow: Locate your draft record and click Submit for Review followed by Confirm.

• Status: The application status will change to Pending order.

3. Approval Workflow

• Review Process: The system routes the request through the configured approval flow (e.g., Level 1 and Level 2 reviewers).

• Applications: Reviewers must open the pending order and select Applications Form > Applications.

• Activation: Once all approvals are complete, the API Key status changes to Approved and becomes active on the specified Effective Date.

4. Issuance and Notification

• Email Delivery: Upon final approval, the system automatically schedules the notification email to be sent with a default delay of approximately 10 minutes after the approval timestamp.

• Email Content: The email is titled "【digiRunner】Notification API Key Authorization Result" and is sent to the applicant.

• Retrieve Credentials: This email contains your API Key (Public) and Secret Key (Private).

  • Security Warning: Keep your Secret Key confidential. It is required for generating signatures (DGRK) during API calls.

5. Verification & Usage

• Track Status: You can view the full audit trail under System Information > API Key Approval History.

• Test Connectivity: To use the key, select DGRK as the Authorization type in your API client, input your keys to generate a signature, and execute the request.