Explore API Builder Module

1. Enter the Kuika platform and open your project from the Apps screen.

2. Open the API Builder module.
3. Choose a name for a new API.
4. Create your API by clicking the CREATE button.

API Builder module allows you to manage all API definitions created on Kuika. What you can do in this module:

• Create new APIs: You can define new APIs according to the needs of your application.
• Edit existing APIs: You can change API names, descriptions and basic settings.
• Delete APIs: You can remove unused APIs with the Delete icon.
• API status check and preview: You can test the working status of APIs and examine data returns.‍
• Security and authorization: You can ensure that APIs are only accessible by authorized users.

1. Create a new method in API Builder by clicking the ADD NEW METHOD button.
2. Specify a method name and configure the settings in the Properties panel.
3. Select method authorization:
   
   • Anonymous Access: The API will be accessible by everyone.
   • All Roles Access: All authorized users can access.
4. Determine which actions the method will perform when called with the Add Actions option.
5. Define Method Input to allow the API to receive parameters from outside.

Example Scenario: API Method Usage

Scenario: An application will return menu status information when a barcode number is entered.

1. Create a new Custom Action in the UI Design module or Datasources module.
2. Add the following query to the SQL Editor:

SELECT Barcode, Status FROM Menu WHERE Barcode = @Barcode

3. Name your action Status Inquiry and click the CREATE button.
4. Add this action to the API Method with the +ADD ACTION button.
5. Select Action Results → Status Inquiry with Symbol Picker.
6. Define Barcode as Method Input:
   
   • Input Name: Barcode
   • Input Type: Guid
7. Test the API by pressing the Preview button.
8. Review the API and method output from the Swagger page.
9. Determine whether the API will be open to everyone or logged in users from the Authorization setting.

With this training content, you have gained basic knowledge about creating APIs, defining methods and managing APIs in the Kuika API Builder module. You can complete your development by testing your API and optimizing its settings.