Kuika's API Builder module offers you the possibility to turn your application into a data source for other applications and services. API stands for “Application Programming Interface” and is an interface that allows a software application to communicate with another application or service. APIs allow different systems and applications to exchange data in a standardized way so that applications can easily interact with each other. The API Builder module enables your application to be used as a data source by other platforms, making it easier for the application to send and receive data. For example, you can enable a food ordering application developed on Kuika to retrieve a restaurant's menu. For this process, the API provides an endpoint (URL) that will allow your application to access the restaurant menu. Your app sends a request to this URL and can retrieve the restaurant's menu and display it to the user. Likewise, when an order is placed, your app can communicate that order to the restaurant through the API and receive feedback on the order status.In this tutorial, you will learn how to configure API definitions using Kuika's API Builder module.
API Builder module is supported in web and mobile applications.
This training content consists of the following topics:
Creating an API Builder,
API Builder panel,
API Method creation and Properties panel.
Create API Builder
After logging into the Kuika platform, open the project you will work on from the “Apps” screen.
Then click on the “API Builder” module.
Give a name (1) from the screen that opens and click on the “CREATE” (2) button.
API Builder Panel
API Builder Panel is a control panel where all API Builder definitions created on Kuika are managed together. Thanks to this panel, you can perform API management quickly and easily. The main functions offered by the API Builder Panel on the left side are as follows:
Creating a New API: Through the panel, you can create a new API definition that your application needs. During this process, you can do the basic configuration of the API and specify the building blocks needed for data exchange. For example, if you are developing a food ordering application, you can create APIs that can manage data such as restaurant menu and order information through this panel.
Updating Existing APIs: The panel allows you to edit the naming, description and general properties of created APIs. Making changes to API names or descriptions provides an organized structure without disrupting the overall structure of your application. This way, you can better organize your app's APIs and manage relationships with different data sources.
API Deletion: You can delete APIs that are no longer needed or used during the development process with the help of the Delete icon on the API Builder Panel. Especially, removing APIs that are used in older versions or replaced with a different function is important for the performance and security of the application.
API Status Check and Preview: You can review the working status of APIs through the panel and test them in a live environment if needed. This allows you to check whether the APIs are working correctly and detect potential problems in advance. Also, thanks to the preview, you can examine the API's data return format and output in advance and make corrections if necessary.
Security and Authorization Settings: You can use the panel to take necessary security measures and configure authorization processes on APIs. You can protect data security by ensuring that APIs are only used by authorized users or applications.
API Builder Method Creation and Properties Panel
Once the API Builder is created, you can start defining a new method by clicking the ADD NEW METHOD button in the upper right corner of the screen. After this step, you can set a name for the method and configure the properties of the method. During the method creation process, you can use the Properties panel on the right side of the screen to authorize and add actions. You can delete or rename the methods you created at any time.
Fields in Properties Panel:
Authorization: You can determine the use of the API with authorization options. If you want the API to be used by everyone without any authentication, you can select Anonymous Access. You can also use the All Roles Access option to make it available to all roles.
Add Actions: Allows you to add platform actions that you want to run when the method is called. If the method needs to perform an action via API, you can define an action here.
3. Method Input: If your method will work by taking a specific input value, you can define input properties through this field. These properties include details such as input name and type.
Example Scenario: Using API Method Structure
For example, let's say you are developing an application that serves menu content. In this application, you may want to take a Barcode number as input and return the status code as respons.
First, create a new Custom Action using the Custom Actions panel in the UI Design module or the Datasources module. This Custom Action will take an input and return a status code as a result.
You can write the necessary queries by entering the SQL Editor field. The SQL editor accepts queries that you write by hand or queries created with the help of artificial intelligence. For example, you can add the following query:
SELECT Barcode, Status FROM Menu WHERE Barcode = @Barcode
2. Give your action a name (for example, Status Inquiry) and click the CREATE button. To call this action into an API Method, click the +ADD ACTION button and add the action by typing Status Inquiry in the search bar.
3. Define the parameter of the created action as Action Results → Status Inquiry via Symbol Picker.
4. The Barcode parameter you specified with "@" in the SQL Editor must be opened to the API as an external method input. For this, click the +ADD METHOD INPUT button, type Barcode in the Input Name field, set the input type as Guid and click the Create button.
The action you created is ready to receive external parameters and execute SQL queries. Click the Preview button to test all configurations. As a result of the preview, you can view your API and the added method operations by clicking Swagger in the URL section. You can set whether these operations can be viewed only by logged in users or by everyone in the Authorization field in the Properties panel.
