| Term | Definition |
|---|---|
| AC (Admin Console) | The primary interface in digiRunner for administrators to manage API configurations, monitor system performance, set access control policies, and oversee user roles and permissions. |
| Alert Settings | A feature for administrators to configure custom alerts for monitoring API performance and system health. Alerts can be triggered by predefined thresholds (e.g., CPU usage, response time, error rates) and notifications sent via email or messaging platforms. |
| API Avg. RESP Time | The average time taken for an API to process a request and deliver a response. |
| API Calls | The requests made by API Clients to access or interact with APIs, including sending data, retrieving data, or invoking actions on backend systems through defined endpoints. |
| API Client | An entity that consumes APIs registered in digiRunner, authenticated through unique credentials (Client ID, display name, tokens) for secure access and integration with specific APIs. |
| API Group | A collection of APIs grouped for streamlined management and access control, allowing administrators to define permissions and security levels for easier assignment to API Clients. |
| API GTW traffic | The volume and pattern of data requests and responses passing through the API Gateway. |
| API Key | A unique identifier issued to API Clients for authentication and access control, used to track and authorize requests, ensuring that only permitted clients can interact with the APIs. |
| API Key Approval History | A record of all approval actions related to API Key requests. |
| API Modify Batch | A feature for administrators to perform bulk updates to multiple APIs, including enabling/disabling, modifying authentication settings, updating metadata, and applying consistent configurations across selected APIs for efficient management. |
| API RESP distribution | A report that visualizes the distribution of API response statuses (e.g., success, errors) over a given time period, helping administrators optimize performance and detect anomalies. |
| API Scope | A granular level of access control that defines the specific operations or data an API Client can perform or access, limiting API usage to predefined functionalities and ensuring secure and precise permission management within API Groups or individual APIs. |
| Approval Flow Settings | A feature for administrators to configure and manage workflows for approving requests, such as API publishing, client account creation, or API authorization. |
| Application Forms | A feature that facilitates managing and submitting requests related to API usage, such as API publishing, client account creation, and API authorization. Application Forms streamline the approval process by allowing administrators to review, approve, or reject requests within the platform. |
| Applications | Registered entities or systems that consume APIs within the platform. |
| Authentications | Mechanisms to verify the identity of API Clients or users before granting access to APIs. Supported methods include OAuth 2.0, JWT, LDAP, and Mutual TLS. |
| Bad Attempt Report | A report that logs and analyzes failed API call attempts, such as unauthorized access, invalid requests, or rate limit violations. |
| Certificate Management | The administration of digital certificates (e.g., JWE, TLS) for securing API communications, ensuring encryption, validating client identities, and enabling secure data transmission between systems. |
| Client Export/Import | A functionality that enables administrators to export API Client configurations as a file for backup or migration, and import them to restore or replicate settings across environments. |
| Customer Setting | Customizable parameters or configurations specific to an organization or client within the platform. |
| Development Mode | A mode in digiRunner for administrators to simulate and validate API setups, user interactions, and system behaviors in a non-production environment, without impacting live services. |
| Embedded Function Management | The administration of built-in functions and services integrated into digiRunner, including their configuration and activation. |
| Files | Digital assets or documents stored in the platform, such as configuration files, logs, and reports. |
| Function Management | A feature in the Admin Console for administrators to configure, view, and manage functions, ensuring secure and organized access. |
| GTW (Gateway) | A centralized entry point that handles API traffic between clients and backend services. |
| IdP (Identity Provider) | A service that authenticates user identities and provides access tokens based on roles and permissions. |
| Items | Configurable elements representing specific data points or attributes, such as system resources, API properties, or user-defined variables. |
| Mail Log | A record of all email communications sent by the system, including notifications, alerts, and confirmations. |
| Mail Template Export/Import | A feature for administrators to export and import email templates, enabling backup, sharing, and standardized communication formats. |
| Online Console | A real-time monitoring interface for administrators to track API performance, analyze logs, and view system health. |
| RDB Connection | A configuration for establishing connections to relational databases (RDBs). |
| Recurring Tasks | A feature that automates tasks to repeat at specified intervals. |
| Reports | A feature that provides detailed analytics and insights into API usage, performance, and system operations. |
| Role Mapping | The process of assigning users or groups to specific roles in digiRunner, ensuring proper permissions and access control across the Admin Console and API resources. This feature streamlines permission management by linking roles to users or groups based on their responsibilities. |
| Scheduled Tasks | A feature for administrators to automate specific operations or processes at predefined times. |
| Security Level | A classification system that defines access permissions and protection measures for APIs, ensuring authorized access to API Groups or individual APIs. |
| Setting | A configurable parameter that controls the operation of specific features or functionalities within the platform. |
| Static Webpage Reverse Proxy | A feature that routes client requests for static web pages (e.g., HTML, CSS, JS) through a reverse proxy, optimizing delivery with caching and access management for faster load times and enhanced security. |
| System Configs | A section for managing core platform settings, including preferences, item configurations, proxy settings, and API parameters. |
| System Information | A centralized repository of data about the platform's configuration, performance, and operational status. |
| txID (Transaction ID) | A unique identifier assigned to each API transaction or request in digiRunner. |
| WebSocket Proxy Management | A feature for administrators to configure and manage WebSocket proxies for real-time, bidirectional communication between clients and servers. |