API Builder Method Creation and Properties Panel

• In the API Builder, click the ADD NEW METHOD button to create a new method.
• Specify the method name and configure the method settings using the Properties panel on the right.

Properties Panel Fields

Authorization

You can configure authorization settings specific to the method in this field. The access level for the API method can be specified.

• 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 type the method will work with.

Supported method types:

• POST
• GET
• PUT
• DELETE
• PATCH

The selected HTTP Method determines the API's data retrieval or data modification behavior.

Content Type (Request)

Determines 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, application/json
• If form data is to be sent, application/x-www-form-urlencoded should be selected.

Response Settings

Content Type (Response)

Determines the format of the response returned by the API.

Supported response types:

• application/json
• text/html

application/json is generally preferred for data-based APIs.

Actions

Actions to be performed when the method is called are added using the + ADD ACTION button.

Added actions:

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

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

Method Inputs

Enables the API to receive parameters from outside.

Input Type

• Manual: Parameters are defined individually.
• Dynamic: Parameters are received via the JSON object structure.

Manual Input

Click the + ADD METHOD INPUT button to add a new parameter.

Fields:

• Input Name
• Type
• Description

Payload type can be selected:

• 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 particularly used for:

• Bulk record insertion
• Bulk update
• Multi-product / multi-row data transmission
• Batch processing scenarios.

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 understands the type of the relevant parameter based on the values found here. Below are the critical ones and the system's default type definition criteria:

Numeric: If the value is not Float, the system automatically selects the Long type. If the value is Float, i.e., contains “.”, the system determines the type of the relevant parameter as decimal.

DateTime: The system only recognizes the “iso” format as DateTime. DateTime values other than “YYYY-MM-DDThh:mm:ss” are automatically defined as string type.

Example Scenario

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

1. Enter the API Builder module.
2. Create a new method with ADD NEW 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 setting.
7. Add the Status Inquiry action using + ADD ACTION.
8. Select Action Results → Status Inquiry using the Symbol Picker.
9. For Method Input:
   
   • Input Name: Barcode
   • Type: Guid
   • Payload: Object
10. Test the API using the Preview button.
11. Check the method output from the Swagger screen.