Swagger API is one of the external data sources you can use on the Kuika platform. You can integrate an existing Swagger API as a data source into the application you develop in Kuika. In this tutorial, you will learn how to add a data source to your application using Swagger API.

In order to use the Swagger API, you need to upgrade your current subscription plan. By upgrading your subscription, you can access features such as API management, Swagger integration, and advanced data sources. For detailed information, you can visit the Pricing page.

This course consists of the following topics:

Add a data source connection to your app with Swagger API
Anatomy of the Swagger API modal
Configure Swagger API connection settings

Add Data Source Connectivity to Your App with Swagger API

Log in to the Kuika platform and open the project you will work on from the Apps screen.
Open the Data Sources module. In this module you can view data sources, actions and tables and add a new data source.

Add a new data source by clicking the + icon next to the Sources heading.

Select the Swagger API option and enter a name for your data source.
Complete the process by clicking the CREATE button.

Anatomy of the Swagger API Modal

A. Top Menu

Title: The field where you can name the connection settings.
CANCEL and CREATE Buttons: You can cancel or save the changes made.

B. Connection Settings

Swagger URL: Enter the URL of the JSON file of the Swagger API.
Service Base URL: Enter the base service URL of the API.
Description: You can add a description about Swagger API.

C. Authentication

Authentication Type: Specify the authentication type for API access (No Auth, Bearer, Basic, API Key).‍
Add Field: Used to add a field to authentication.

Configure Swagger API Connection Settings

After clicking the CREATE button, open the Connection Settings section.
Enter Swagger URL and Service Base URL.
Select the authentication type from the Authentication Type drop-down menu.
- No additional action is required when No Auth is selected.

Swagger API Authentication Types

1. Bearer Authentication

Select Bearer from the Authentication Type drop-down menu.
Kuika creates the Username parameter by default.
You can add custom parameters using the Custom option.
Enter parameter information as a key-value pair.
- Example: Key: client_id, Value: your_client_id
Save by clicking the CREATE button.

2. Basic Authentication

Select Basic from the Authentication Type drop-down menu.
Enter Username and Password.
You can add custom parameters using the Custom option.
Check the automatically generated “{BasicAuthToken}” value for Basic Authentication.
Save by clicking the CREATE button.

3. API Key Authentication

Select API Key from the Authentication Type drop-down menu.
Enter the following information to use the API Key authentication type:
- ID key name: Key name representing the client ID.
  - Example: client_id
- ID Client ID.
- Secret key name: The key name representing the client secret key.
  - Example: client_secret
- Secret: Client secret key.
You can add custom parameters using the Custom option.
Save by clicking the CREATE button.