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?

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. This is a mandatory step, as the system relies on SMTP to deliver approval workflows and credential notifications.

• API Registration: Only select APIs that are already registered under 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 stating "1298 - No information found", you can safely ignore it and proceed by clicking Apply.

   • Configure Key Details: Complete 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, then click Submit for Review followed by Confirm.

   • Status: The application status changes to Pending Order.

3. Approval Workflow

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

   • Access Applications: Reviewers must open the pending order and navigate to 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, typically sent around 10 minutes after approval.

   • 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 and Usage

   • Track Status: 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.

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