Skip to main content
Version: 5.3.0 - 5.3.2

Manage external APIs

note

You need the admin rights to use this feature.

External API management lets administrators make external datasources available in Runtime. After the external configuration is published from Designer and imported into Runtime, applications and services can invoke third-party APIs through KAIZEN Gateway using the configured provider, environment, authentication, and datasource settings.

Use an external datasource in Runtime​

Before using an external datasource in Runtime, publish the external configuration from App Designer to the target Runtime environment. Refer to External API integration on how to configure an external API.

  1. Export the external configuration XML file from Service Designer.

  2. Import the XML file in the Access Controller > External API page.

  3. Confirm that the provider, environment, authentication, and datasource are all Active.

  4. Assign datasource invocation permission to the target application or service.

Custom backend services must call KAIZEN Gateway instead of calling the third-party API directly. Send a POST request to the following endpoint:

/bridge/{datasource-identity}

For example, call a datasource with the identity tlsVersionCheck:

POST /bridge/tlsVersionCheck

Request headers include:

  • Provider-Name: tls-test
  • Content-Type: application/json

To send the request in Postman:

  1. Set the method to POST.

  2. Set the URL to https://ecq.lowcode.com/bridge/tlsVersionCheck

  3. Add the following header:

    • Provider-Name: tls-test

  4. Leave the body empty, or provide JSON that matches the datasource configuration.

    Send the request in Postman

KAIZEN Gateway performs the following steps:

  1. Find the external datasource configuration using Provider-Name and dsIdentity.

  2. Build the external API URL from the environment base URL and datasource path.

  3. Add authentication information according to the authentication configuration.

    For NO_AUTH, Gateway does not add an authentication header or query parameter.

  4. Forward only the request fields permitted by the datasource configuration.

  5. Return the external API response in the KAIZEN response format.

HTTPS and TLS​

The TLS protocol version is negotiated between the WebClient used by Gateway and the external API endpoint. If both the runtime and the external endpoint provide support, TLS 1.3 can be negotiated.

KAIZEN External Datasource does not provide a datasource-level switch to force outbound calls to use TLS 1.3 only. This article uses https://www.tlsversion.com/v1/version.json as the test endpoint and checks the negotiated result through the version field in the response.

Last updated on 21 Sep 2026