What is the complete API key application process?

[EX0429]

Hi everyone,
I'm a bit confused about how to apply for an API key.
I'd like to learn the complete API key application process.
Can someone guide me step by step?

[TPIsoftwareOSPO]

Absolutely! Here’s the full process — from applying for an API Key to approval and issuance.
This includes intermediate approvals, configuration notes, and security reminders 👇

---

✅ 1. Application initiation

1. Navigate to Application Forms → API Key.
2. Search and select your target Client.
   o If no API list exists, you might see the message “1298 - No information found.” That’s normal — just continue to click Apply.
3. Click Apply and fill in all required fields:
   o API Key Name
   o Effective Date / Expiry Date
   o Use Quota (use -1 for unlimited)
   o Description
   o Select API(s) (choose from APIs already registered under API Management → API List)
4. In the Select API window:
   o Search by keyword or open API details (using the 🔍 icon).
   o Add one or more APIs to include in this key.
   o Double-check and delete any mistaken selections before saving.
5. Click Save to create your draft application — this also registers it under Application Forms → Applications.
   📖 Reference: API Key
   📖 Reference: Applying for API Key

---

🔄 2. Submitting for approval

1. Go to Application Forms → Applications.
2. Find your draft record and click Submit for Review → Confirm to begin the approval workflow.
3. Once submitted, the application status changes to Pending order.
   📖 Reference: Obtaining API Keys and Calling APIs

---

🧾 3. Approval workflow (multi-level review)
• The system supports two levels of approval.
• Reviewers and their roles can be configured under Application Forms → Approval Flow Settings.
Process example:

1. Level 1 reviewer: opens the Pending order, clicks Sign-off, then chooses Approve.
2. Level 2 reviewer (if applicable): performs the same steps — Sign-off → Approve.
3. After all configured reviewers approve, the system automatically marks the application as Approved, and the API Key becomes active starting on the Effective Date.
   📖 Reference: Approval Flow Settings

---

✉️ 4. Issuance and notification
Once the final approval is complete:
• The system automatically emails the applicant a message titled:
“【digiRunner】Notification API Key Authorization Result.”
• This email contains the API Key and Secret Key (or X-API-Key, depending on your setup).
📖 Reference: Obtaining API Key and Secret Key

---

🧠 5. Using your API Key
To call APIs with your issued key:

1. Choose DGRK as your Authorization type.
2. Enter your API Key (public) and Secret Key (private) received by email or stored in your database.
3. Use these values to generate a signature (DGRK).
4. Test your API by selecting Authorization → DGRK → Test.
   📖 Reference: Calculating the Signature and DGRK
   📖 Reference: Obtaining API Keys and Calling APIs

---

📋 6. Tracking and managing applications
• You can review all approval records and issuance logs under:
System Information → API Key Approval History
• From the Applications page, you can also view, edit, or revoke pending or approved applications.
📖 Reference: API Key Approval History

---

⚠️ Important notes
• SMTP setup is required before applying — otherwise, system email delivery (for approvals and key notifications) will fail.
📖 Reference: Obtaining API Keys and Calling APIs
• Always select APIs whose source is “registered” in API Management → API List.
• Ensure the Effective Date and Expiry Date are correctly set — expired keys cannot call APIs.
• When configuring quota, -1 means unlimited; otherwise, specify a call limit.
• Confirm that all reviewer roles are correctly configured in Approval Flow Settings to prevent sign-off delays.
• Keep your Secret Key secure — treat it like a password.