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
  • Registering APIs
  • Enabling/Disabling APIs
  • Testing APIs

Was this helpful?

Export as PDF
  1. Get Started

Registering Your First APIs with digiRunner

Registering, Enabling, and Calling APIs with No Auth

PreviousSMTP ConfigurationNextClient Authorization and Calling APIs

Was this helpful?

Register external APIs to digiRunner, and after they are enabled, the APIs can be called through digiRunner.

Registering APIs

The system can register the APIs saved on the AP Server into the system, and then have the system manage the APIs.

  1. Go to API Management > API Registration, and click CUSTOMIZE to enter the registration page.

  2. Fill in the required fields: Target URL, API Name, digiRunner Proxy Path and Http Methods.

  3. Since authentication is not required for now, select No Auth.

  4. Click Register to complete the registration of that API.

Enabling/Disabling APIs

Enable/Disable can be used to restrict the calling of APIs registered into system management.

  1. Go to API Management > API List to query APIs that have been registered successfully.

  1. Click Test to view the response. In this example, the Status code returned is 503, and the Body contains the data "API was disabled".

  1. Click Test to view the response. In this example, the Status code returned is 200, indicating a successful call, and the Body contains the data defined by that API.

Testing APIs

APIs registered into system management can be called from the API test area. NO Auth is used as the example below.

  1. Select No Auth for Authorization. The target URL will be retrieved automatically for the digiRunner URL field, and the default Http Method is GET.

  2. Click Test to view the response. In this example, the Status code returned is 200, and the Body contains the data defined by that API.

  1. Go to API Management > API Test, and fill in the digiRunner URL field with the target URL.

  2. Select No Auth for Authorization.

  3. Click Test to view the response. In this example, the Status code returned is 200, and the Body contains the data defined by that API.

Next, you can try our most common use cases.

Go to API Management > API List to query the API just registered, the default status of the API is disabled ().

For more information on creating an API proxy, please refer to .

Click on the icon to open the testing area, and select No Auth for Authorization.

Return to the list and select the API; the default status at this time is disabled (). Select the API, and click Enable.

A confirmation window for enabling will pop up, click Confirm, and the API status will be updated to enabled ().

Click on the icon to open the testing area, and select No Auth for Authorization.

Go to API Management > API List, and query APIs that have been registered successfully into API, then click on the icon to open the testing area.

API Registry
Most common use cases

Client Authorization and Calling APIs

Rate Limiting

Proxy Caching

Load Blancing

Sandbox Testing

VIP Gateway Priprity Settings

JWE Certificate