Rest API Data Source User Guide

Rest API Data Source User Guide

Rest API

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

In order to use the Rest API, you need to upgrade your existing subscription plan. With a subscription upgrade, you can benefit from features such as API access, integrations, and advanced data management. For detailed information, you can visit the Pricing page.

This training content consists of the following topics:

  • Add a data source connection to your app with Rest API
  • Anatomy of the Rest API modal
  • Configure Rest API connection settings
Add Data Source Connectivity to Your App with Rest API
  1. Log in to the Kuika platform and open the project you will work on from the Apps screen.
  2. Open the Data Sources module. Here you can view data sources, actions and tables and add a new data source.
  3. Add a new data source by clicking the + icon next to the Sources heading.
  1. Select Rest API and enter a name for your data source.
  2. Complete the process by clicking the CREATE button.
Anatomy of a Rest API Modal

A. Top Menu

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

B. Connection Settings

  • 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 Rest API Connection Settings
  1. After clicking the CREATE button, open the Connection Settings section.
  2. Enter the Service Base URL information.
  3. Select the authentication type from the Authentication Type drop-down menu.
    • No additional action is required when No Auth is selected.

Rest API Authentication Types

1. Bearer Authentication

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

2. Basic Authentication

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

3. API Key Authentication

  1. Select API Key from the Authentication Type drop-down menu.
  2. 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: Key name representing the client secret key. (Example: client_secret)
    • Secret: Client secret key.
  3. You can add custom parameters using the Custom option.
  4. Save by clicking the CREATE button.

By following these steps, you can integrate the Rest API data source into your Kuika applications.

Other Related Content

No items found.

Glossary

No items found.

Alt Başlıklar