User Guide for Adding a Data Source with OData

1. Log in to the Kuika platform and open the project you want to work on from the Apps screen.
2. Open the Data Sources module. In this module, you can view data sources, actions, and tables, and add a new data source.
3. Click the + icon next to the Sources heading to add a new data source.

4. Select the OData API option and enter a name for your data source.
5. Click the CREATE button to complete the process.

A. Top Menu

• Title: Area where you can name the connection settings.
• CANCEL and CREATE Buttons: Allows you to cancel or save the changes made.

B. Connection Settings

• Metadata URL: Enter the URL of the service metadata (schema) file.
• Service Base URL: Enter the base URL of the OData service.
• Description: A field where you can add a description about the data source.

C. Authentication

• Authentication Type: Select the type of authentication for API access (No Auth, Basic, OAuth2).‍
• Add Field: Used to add a field for authentication.

1. After clicking the CREATE button, in the Connection Settings section:
   
   • Enter the Metadata URL and Service Base URL information.
2. Select the authentication type from the Authentication Type dropdown menu.
   
   • If No Auth is selected, no additional configuration is required.

OData API Authentication Types

1. No Authentication: Used for services that do not require authentication. No additional settings are required.

2. Bearer: Token-based authentication method. In some cases, a username can be used to obtain a token.

• Usage:
  
  • Authorization: Bearer YOUR_ACCESS_TOKEN
• If the token is obtained with a username and password, a ‘login’ process must be performed first, and then the process must be continued with the obtained token.

3. Basic Authentication: Authentication is performed with a username and password.

• Username: Username
• Password: Password
• Usage:
  
  • Authorization: Basic base64(username:password)
• You can add custom parameters if you wish.

‍

4. API Key Authentication: An API key and sometimes a secret key are used for authentication to access the API. This information is usually provided by the API provider and sent as a header or query parameter.

Parameters that can be used:

• ID Key Name: Name of the API identity key
• (e.g. client_id, api_key, x-api-key)
• ID: Your unique API identity value
• Secret Key Name: The header name of the secret key
• (e.g. client_secret, secret_key)
• Secret: Your unique secret key value
• Submission Methods:
  
  • Header:
    
    • client_id: YOUR_ID
    • client_secret: YOUR_SECRET
  • With Query Parameter:
    
    • https://api.example.com/data?client_id=YOUR_ID&client_secret=YOUR_SECRET

These values may have different names depending on the API provider's documentation. In Kuika, you can define these values as the correct header or parameter to complete the integration.

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