1. Log in to the Kuika platform and open your project from the Apps screen.
2. Open the API Builder module from the top menu.

3. On the screen that opens, click the Create a blank API card.

4. In the window that opens, enter a name for your API in the Name field and click the CREATE button. You can cancel the process by clicking CANCEL.

On the API Builder main screen, there are two tabs that allow you to view the APIs you’ve created:

• Recently modified: This is the default view, listing the most recently updated APIs.
• All APIs: This view lists all APIs in your project.

In both lists, you can search by name using the Search by name... box. The table consists of the following columns:

• Name: The name of the API.
• Methods: The number of methods defined for the API; if no methods have been added yet, it is displayed as “—”.
• Access: The API’s access level; if not yet defined, it is displayed as “—”.
• Last modified: The person who last updated the API and the time of the update.

Here’s what you can do in this panel:

• Create a new API: You can define new APIs based on your application’s needs.
• Edit existing APIs: You can change API names, descriptions, and basic settings.
• Delete an API: You can remove unused APIs using the Delete icon.
• Check API status and preview: You can test the operational status of APIs and review data responses.
• Security and Authorization: You can ensure that APIs are accessible only to authorized users.

When you enter an API you’ve created, the API name (which can be changed via a dropdown list) appears at the top, along with an edit (pencil) icon next to it.

If no methods have been added yet, the screen displays an Add a method card with the message “No API Method exists. — Add a method to expose one of this API's operations.” below it.

When you click this card, the New Method window opens:

• Name: The method’s name (required field).
• Description: A field describing what the method does (optional).

SAVE to create the method, or CANCEL to cancel.

After the method is created, a table listing the created methods appears on the left. You can search among the methods using the Search by name... box. Table columns:

• Method: The method’s name.
• Verb: The HTTP method type (e.g., POST).
• Access: The method’s access level (e.g., All roles).
• Actions: The number of actions associated with the method.
• Method Inputs: The number of input parameters defined for the method.

When a method is selected, the Properties panel opens on the right.

Properties Panel Fields

Authorization

You can configure method-specific authorization settings in this section. The panel includes a dropdown menu (⋮) and an expand arrow (>). You can set the access level for the API method:

• Anonymous Access: The API is accessible to everyone.
• All Roles Access: All authorized users can access it.
• Role-based access restrictions can be defined.

Request Settings

• HTTP Method: Specifies which HTTP method the API will use. Supported HTTP methods: POST, GET, PUT, DELETE, PATCH. The selected HTTP method determines whether the API retrieves or modifies data.
• Content Type: Specifies the format of the data to be sent to the API. Supported content types: application/json, application/x-www-form-urlencoded, application/xml. For example, if a JSON payload is to be sent, select application/json; if form data is to be sent, select application/x-www-form-urlencoded.

Response Settings

• Content Type: Specifies the format of the response the API will return. Supported response types: application/json, text/html. application/json is generally preferred for data-driven APIs.

Actions

Actions that will run when the method is called are added using the + icon on the right. If no actions have been added yet, the message “No actions yet. Add action” is displayed. Added actions:

• Custom Action
• SQL Action
• REST Action
• System Action

Action results can be linked to the Response via the Symbol Picker.

Method Inputs

Allows the API to accept parameters from external sources. Click the + icon on the right to add a new input parameter.

• Input Type:
  
  • Manual: Parameters are defined one by one.
  • Dynamic: Parameters are retrieved via a JSON object structure.
• Payload As:
  
  • Object
  • List of Objects: Thanks to the array (multi-row) data structure, the API method can process multiple records in a single request. This structure is used specifically for bulk record insertion, bulk updates, sending multiple product/multi-row data, and batch processing scenarios.

Manual Input

• Click the “ADD METHOD INPUT” button to add a new parameter. Fields:

• Input Name
• Type
• Description

Dynamic Input

When “Dynamic” is selected, the JSON Object field opens. Example structure:

{“paramName”: “Value1”,‘paramName2’: 10,“paramName3”: 10.4}

This structure defines the request body expected by the method. The system automatically determines the type of the relevant parameter based on the values provided here. The critical criteria the system uses for default type determination are listed below:

• Numeric: If the value is not a Float, the system automatically selects the Long type. If the value is a Float—that is, if it contains a “.”—the system sets the relevant parameter type to Decimal.
• DateTime: The system only recognizes the “iso” format for DateTime. All other DateTime values in the “YYYY-MM-DDThh:mm:ss” format are automatically set to the string type.

Example Scenario

An API will be created that returns the menu status based on a barcode number.

1. Go to the API Builder module.
2. Create a new method using Add a method.
3. Select POST as the HTTP Method.
4. Select application/json as the Request Content Type.
5. Select `application/json` as the Response Content Type.
6. Configure the Authorization settings.
7. Add the “Status Inquiry” action using the + button under “Actions.”
8. Using the Symbol Picker, select “Action Results → Status Inquiry.”
9. For Method Input:
   
   • Input Name: Barcode
   • Type: Guid
   • Payload: Object
10. Test the API using the “Preview” button.
11. Check the method output on the Swagger screen.