Explore API Builder mode

Use API service in Kuika with API Builder.

API stands for Application Programming Interface. An interface that allows a software application to communicate with another application or service. APIs make it easy for different systems and applications to work together and exchange data.

APIs enable data transmission between various platforms. An application uses APIs to receive or send data from another application or service. APIs standardize this data exchange and facilitate interaction between applications.

Kuika offers its API service to users with the API Builder view mode in the application. With API Builder view mode, you can use the application you developed with Kuika as a data source for different applications.

For example, consider that your food ordering application developed on Kuika retrieves a restaurant's menu. The API provides a specific endpoint (URL) for your app to retrieve the restaurant's menu. Your app sends a request to this URL and the API returns the restaurant's menu back to you. In this way, your application can retrieve the restaurant's menu and display it to users.

Likewise, when the user places an order, your app can forward that order to the restaurant via the API. The API verifies that the order has been delivered to the restaurant and forwards the response from the restaurant to you, allowing the user to give feedback.

You can turn the applications you developed in Kuika into data sources as APIs via API Builder view mode.

API Builder supports mobile and web applications.

  1. Build API Builder

  2. API Builder Panel

  3. API Builder Method Build and Properties Panel

1. Build API Builder

Open it by clicking the API Builder icon from the view modes in the Header in the application.

Name the API Builder to be created on the screen that opens and click the CREATE button.

2.API’ s Panel

It is the panel where the created API Builders are located. Through this panel, you can create a new API, change the name of existing APIs, and delete APIs.

3.API Builder Method Build and Properties Panel

After the API Builder is created, start creating the API Builder Method by clicking the ADD NEW METHOD button in the upper right corner of the screen that opens and naming it. When creating the method, there is the Properties panel on the right. You can perform authorization and adding actions using the Properties panel. You can delete or rename the methods you created at any time.

In the Properties panel, there are Authorization, Actions, Method Inputs fields.


The Anonymous Access option is used to open the API service by authorizing All Roles Access and to use it without any verification.

Add Actions

It is the area where the actions that are requested to run on the platform side are added when the method is called.

Method Input

If the actions to be used contain input values, the type, name, etc. of these values is the field where the properties are entered.

On an example scenario, the API method structure can be discussed. For example, suppose you have an application with a menu in it. Let the Barcode number be given as input in this application. You return the status code as responsive.

First, create a new Custom Actions in the UI Design view mode in the application, through the Custom Actions panel or under the Actions title that you added to the data source in the Datasources view mode. This will take an input with Custom actions and return a responsive value as a result.

You can write the desired queries manually in the opened SQL Editor or you can easily add queries with the help of artificial intelligence.

After adding queries such as

select Barcode Statu from Menu 
Where Barcode = @Barcode 

into the SQL editor, name it like status inquiry and click the CREATE button. Click +ADD ACTION to call the created action into API Method. Add the action by typing status inquiry (the action you created) in the search bar. The action parameter created should be filled as Action Results → status inquiry (action you created) via Symbol Picker.

Since the Barcode parameter defined with the @ sign in the SQL Editor is the API that opens out, a Method Input must be created. Click + ADD METHOD INPUT to generate Method Input. In the Input Name field, enter the parameter written with @, namely Barcode. Select the input type as Guid and click the Create button.

The created action is ready to receive external parameters and written SQL queries. Click on the Preview button to test the performed operations. As a result, you can view the latest API and added method operations by typing Swagger in the URL section as a result of the preview. you can set.You can set the visibility of the operations to be viewed by Signing in or by everyone through the Authorization field in the Properties panel.

Last updated