Manage providers

A provider in KAIZEN is a configured connection to an external REST API. It allows the backend to call external services as part of its business logic. You can manage providers from the Setting panel in the Service Designer, including their datasources, data types, environment configurations, and branches.

Add a provider

To add a provider, perform the following:

1. In the Setting panel, expand the External section and click the + sign at the Provider dropdown.

2. The Add Provider window appears in the Configuration panel. Fill in the required fields, such as the provider name and base URL.

3. Click Apply to create the provider. It will then appear under the External section in the Setting panel.

Add a datasource

You can add datasources to a provider in the same way as adding them to a service. For detailed instructions, refer to Manage datasources.

Add a data type

Add data types to a provider in the same way as adding them to a service. For detailed instructions, refer to Manage data types.

Add an Env Config

An Env Config defines the environment-specific connection settings for a provider, such as the base URL and security credentials. This allows the same provider to connect to different external API endpoints depending on the environment (e.g., development, staging, or production).

To add an Env Config, perform the following:

1. In the Setting panel, select the provider. Click the + sign at the Env Config dropdown.

   The Add Env Config window appears in the Configuration panel.

2. Fill in the required fields. Refer to the table below for more details.

Env Config configuration fields

This table describes each field in the Add Env Config or Edit Env Config window.

Field	Description
Env	The target environment for this configuration. Select one from the dropdown (e.g., development, staging, or production). This is a required field.
Base Url	The base URL of the external API for the selected environment. This is a required field.
Truststore Type	The type of truststore used for SSL/TLS connections. Select one from the dropdown.
Truststore Data	The truststore certificate file. Click Upload Key to upload the file.
Truststore Password	The password for the truststore file.
Description	An optional description for this environment configuration.
Status	The status of this configuration. Select Active to enable or Inactive to disable. This is a required field.

After filling in the details, click Apply to save the Env Config.

Edit a provider

You can modify an existing provider's configuration at any time; for example, update its name, base URL, or associated datasources.

To edit a provider, perform the following:

1. In the Setting panel, click the provider name under the External section.

   The Edit Provider window appears in the Configuration panel, where you can update the provider's properties.

2. Click Apply to save your changes.

Manage branch

Branch management for providers follows the same workflow as for services. You can create, switch, and manage branches to work on provider configurations in isolation.

For detailed instructions on branch management, refer to Manage branches.

Merge into main

Merging a provider branch integrates your changes into the main branch, making them part of the official configuration.

For detailed instructions on merging branches, refer to Merge branches.

Deactivate provider

You can deactivate a provider that is no longer in use. Deactivating a provider helps maintain a clean workspace and ensures developers focus on active configurations.

To deactivate a provider, perform the following:

1. In the Setting panel, select the provider to deactivate under the External section.

2. Click the Deactivate button on the provider toolbar.

3. A pop-up window appears, asking for confirmation. Click OK.

   A success message confirms that the provider has been deactivated. The provider will no longer appear in the active list.

To reactivate an inactive provider, perform the following:

1. Click Show Inactive Services & Datasources on the toolbar to display deactivated items.

2. Click Activate on the provider.

Export provider

Exporting a provider saves its configuration in an XML file, which can be imported into another project.

To export a provider, perform the following:

1. In the Setting panel, select the provider to export under the External section.

2. Click the Export button on the provider toolbar.

3. The Export Provider window appears, asking for confirmation. Click OK.

   A file in XML format will be downloaded in your browser.

Last updated on 20 May 2026