LogoLogo
TPI.devCommunityGithub
  • Overview
    • Introduction
      • Future Features
    • License & Disclaimer
    • APIM Architecture
      • Production Deployments and Capacity
      • Functions
      • Integration
    • Key Concepts
      • API Group
      • API Scope
      • API Client
      • End-to-End Workflow Combining API Group, API Scope, and API Client
        • Scenario: API Management for an E-commerce Platform
    • Support
    • Glossary
    • Scenarios
      • Financial Industry
        • Transforming Financial Services with digiRunner API Management
        • Redefining Financial Data Migration with digiRunner API Management Platform
      • Manufacturing Industry
        • Enabling Smart Manufacturing with Seamless API Integration and Automation via digiRunner
        • Streamlining Global Operations with API Management via digiRunner
      • Medical Industry
        • Enhancing Healthcare Data Integration and Security with digiRunner API Management
        • Revolutionizing Healthcare Interoperability with digiRunner’s Advanced API Framework
      • Insurance Industry
        • Modernizing Insurance Services with digiRunner API Management
        • Modernizing Insurance with digiRunner—Bridging Legacy Systems and Microservices
      • Government and Public Services
        • Empowering Open Government Services with digiRunner: A Mission for Integration and Transformation
        • Streamlining Public Sector Innovation via digiRunner: Driving Citizen-Centric Digital Transformation
  • Get Started
    • Installing digiRunner API Management
      • SMTP Configuration
    • Registering Your First APIs with digiRunner
    • Client Authorization and Calling APIs
    • Rate Limiting
    • Proxy Caching
    • Load Balancing
    • Sandbox Testing
    • VIP Gateway Priority Settings
    • JWE Certificate
  • Configuring IP Whitelisting via IP Binding
  • Most common use cases
    • Obtaining API Keys and Calling APIs
    • API IP Diversion
    • Viewing Real-time API Logs
    • Enabling APIs and No Auth in Batches with API Imported
    • Role-Based Access Management within a Hierarchical Structure
    • Simplified OIDC Login with Predefined Organizational Frameworks
    • Resetting User Password and Confirmation Email for Admin Console User
  • Guide
    • AC User Management
      • Users
      • My Profile
      • Roles
      • Role Mapping
      • Organization
      • Role & txID
      • Delegate AC User
      • AC OAuth 2.0 IdP
      • AC LDAP IdP
      • AC MLDAP IdP
      • AC API IdP
    • Development Mode
      • Function Management
      • Rtn Code Management
      • Embedded Function Management
    • Client Management
      • API Client
      • API Group
      • API Scope
      • Authentications
      • Security Level
      • GTW OAuth 2.0 IdP
      • GTW LDAP IdP
      • GTW API IdP
      • GTW JDBC IdP
      • Client Export/Import
    • API Management
      • API List
      • API Registry
      • API Test
      • API Modify Batch
    • Monitor & Alert
      • digiRunner Server
      • Alert Settings
    • Reports
      • API Calls
      • API RESP distribution
      • API Avg. RESP Time
      • API GTW traffic
      • Bad Attempt Report
    • Certificate Management
      • JWE Cert. List
      • JWE Cert. Management
      • TLS Cert. List
      • TLS Cert. Management
    • Application Forms
      • API Key
      • Applications
      • Approval Flow Settings
    • System Information
      • API Key Approval History
      • Scheduled Tasks
      • Recurring Tasks
      • Mail Log
    • System Configs
      • Setting
      • Items
      • Files
      • Customer Setting
      • Online Console
      • WebSocket Proxy Management
      • Static Webpage Reverse Proxy
      • RDB Connection
      • Mail Template Export/Import
  • API Integration Guide
    • Using Token for Authentication and Authorization
      • OpenID Connect (OIDC) Mode
      • Client Credentials Mode
      • Password Mode
    • Using X API Key for Authentication and Authorization
      • Applying for X API Key
      • Obtaining X API Key
      • Calling APIs Registered in digiRunner with X API Key
    • Using API Key for Authentication and Authorization
      • Applying for API Key
      • Obtaining API Key and Secret Key
      • Calculating the Signature and DGRK
      • Calling APIs Registered in digiRunner with API Key
    • Using HTTP Basic and OAuth for Authentication and Authorization
      • Calling APIs Registered in digiRunner with Basic Auth
      • Calling APIs Registered in digiRunner with No OAuth
    • Token Lifecycle Management Mechanism
      • Applying Refresh Token
      • Token Revocation
      • Token Introspection
    • JWS/JWE Integration
      • JWS Workflow
      • JWE Workflow
      • Exchanging Public Keys
      • Generating Certificate
      • Operating with JWS
      • Operating with JWE
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Overview

Glossary

Term
Definition

AC (Admin Console)

The Admin Console (AC) is the primary interface in digiRunner where administrators manage API configurations, monitor system performance, set access control policies, and oversee user roles and permissions.

Alert Settings

A configuration feature that allows administrators to set up custom alerts for monitoring API performance and system health. Alerts can be triggered based on predefined thresholds, such as CPU usage, response time, or error rates, and can be delivered via various channels like 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. API Calls include sending data to, retrieving data from, or invoking actions on the backend systems through defined endpoints.

API Client

An entity that consumes APIs registered in digiRunner. API Clients are managed through unique credentials (Client ID, display name, tokens), enabling secure access and integration with specific APIs.

API Group

A collection of APIs grouped together to streamline management and access control. API Groups allow administrators to define permissions and security levels for a set of APIs, enabling 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. API Keys are 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 that allows administrators to perform bulk updates or changes to multiple APIs simultaneously. This includes enabling/disabling APIs, modifying authentication settings, updating API 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, client error, server error) over a given time period. It helps administrators identify trends in API performance, detect anomalies, and optimize backend processing.

API Scope

A granular level of access control that defines the specific operations or data an API Client can perform or access. API Scopes are used to limit API usage to predefined functionalities, ensuring secure and precise permission management within API Groups or individual APIs.

Approval Flow Settings

A feature that allows administrators to configure and manage the workflow for approving requests, such as API publishing, client account creation, or API authorization.

Application Forms

A feature that facilitates the management and submission of 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 exceeded rate limits.

Certificate Management

The administration of digital certificates used to secure API communication. This includes managing JWE and TLS certificates, ensuring data encryption, validating client identities, and enabling secure data transmission between systems.

Client Export/Import

A functionality that allows administrators to export API Client configurations to a file for backup or migration purposes. Similarly, administrators can import these configurations into the system to quickly restore or replicate client settings across environments.

Customer Setting

Customizable parameters or configurations specific to an organization or client within the platform.

Development Mode

A mode in digiRunner where configurations and tests are performed in a non-production environment. It allows administrators to simulate and validate API setups, user interactions, and system behaviors without impacting live services.

Embedded Function Management

The capability within digiRunner to manage built-in functions or services that are integrated directly into the platform. This includes configuring, enabling, or disabling specific functionalities and features as required for system operations.

Files

Digital assets or documents stored within the platform for operational purposes, such as configuration files, logs, or reports.

Function Management

A feature within the digiRunner Admin Console allowing administrators to configure, view, and manage available functions. Function Management ensures that each user role has appropriate access, maintaining organized and secure use of digiRunner’s capabilities.

GTW(Gateway)

A centralized entry point that handles API traffic between clients and backend services.

IdP (Identity Provider)

A service that manages and authenticates user identities, enabling secure access to applications within digiRunner. An IdP verifies user credentials and provides authentication tokens that grant users access based on their roles and permissions.

Items

Configurable elements within the platform that represent 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 that allows administrators to export email templates for backup or sharing purposes and import templates into the system to standardize communication formats.

Online Console

A real-time monitoring interface within the platform that provides administrators with tools to track API performance, analyze logs, and view system health.

RDB Connection

A configuration within the platform that allows establishing connections to relational databases (RDBs).

Recurring Tasks

A feature that enables the automation of 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 associating users or groups with specific roles in digiRunner. Role Mapping ensures that users automatically receive the appropriate permissions based on their assigned role, facilitating organized and secure access control across the Admin Console and API resources. This feature simplifies permission management by linking roles to users or groups according to their responsibilities.

Scheduled Tasks

A feature that allows administrators to automate specific operations or processes at predefined times.

Security Level

A classification system used to define and enforce access permissions and protection measures for APIs. Security levels are applied to API Groups or individual APIs to ensure that only authorized API Clients with matching security clearance can access them.

Setting

A configurable parameter or option within the platform that determines how specific features or functionalities operate.

Static Webpage Reverse Proxy

A feature that routes client requests for static web pages (e.g., HTML, CSS, JS) through a reverse proxy. It optimizes delivery by caching responses and managing access to static resources, ensuring faster load times and enhanced security.

System Configs

A section for managing the platform's core settings, including system preferences, item configurations, proxy settings, and API-related 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 that allows administrators to configure and manage WebSocket proxies, enabling real-time, bidirectional communication between clients and servers.

PreviousSupportNextScenarios

Was this helpful?