5. API Integrations and Connectors

User Manual: Using APIs in the Low Code Platform

Introduction

This manual provides detailed instructions on how to utilize APIs within the Low Code Platform. You will learn how to configure APIs, use them in web forms, integrate them into workflows, and leverage out-of-the-box connectors for seamless integration with external systems.

Table of Contents

  1. Understanding APIs in the Low Code Platform
  2. Configuring APIs
  3. Using APIs in Web Forms
  4. Integrating APIs in Workflows
  5. Using Out-of-the-Box Connectors
  6. Testing and Monitoring API Integrations
  7. Best Practices for API Usage
  8. Conclusion

1. Understanding APIs in the Low Code Platform

APIs (Application Programming Interfaces) allow your application to communicate with external systems or services. In the Low Code Platform, APIs can be integrated into web forms, workflows, and other components to enhance functionality, automate data exchange, and improve user experience.

Key Concepts

  • REST API: A popular architecture for designing networked applications that use HTTP requests.
  • SOAP API: A protocol that defines a set of rules for structuring messages and offers built-in error handling.
  • Out-of-the-Box Connectors: Pre-built integrations with popular external systems that simplify API usage.

2. Configuring APIs

Step 1: Access the API Configuration Panel

  1. Log in to the Low Code Platform.
  2. Navigate to the "APIs & Integrations" section from the main dashboard.
  3. Click on "Create New API" or "Configure Existing API."

Step 2: Define API Details

  1. API Name: Provide a unique name for the API.
  2. Endpoint URL: Enter the URL of the API endpoint (for REST) or the service URL (for SOAP).
  3. HTTP Method: Select the appropriate HTTP method (GET, POST, PUT, DELETE) for REST APIs.
  4. Authentication:
  5. Choose the authentication method required by the API (e.g., OAuth, API Key, Basic Auth).
  6. Enter the necessary credentials or tokens.

Step 3: Set Up Request Headers and Parameters

  1. Headers: Define any required headers (e.g., Content-Type, Authorization).
  2. Parameters: Specify query parameters (for GET requests) or body parameters (for POST/PUT requests).
  3. Data Mapping: Map data fields from the application to the API request parameters.

Step 4: Test the API Configuration

  1. Click on "Test API" to send a test request.
  2. Review the response to ensure the API is configured correctly.
  3. Save the API configuration.

3. Using APIs in Web Forms

Step 1: Add an API Call to a Web Form

  1. Navigate to the "Forms" section and open the form where you want to use the API.
  2. Drag and drop an "API Call" element from the toolbox onto the form.

Step 2: Configure the API Call

  1. Select API: Choose the pre-configured API from the dropdown list.
  2. Trigger Event: Define when the API should be called (e.g., on form submission, on button click).
  3. Map Form Inputs: Map the form fields to the API request parameters. For example, map a text field to a query parameter in a GET request.

Step 3: Handle API Responses

  1. Display Response Data: Configure how the response data should be displayed in the form (e.g., show it in a text box or dropdown).
  2. Error Handling: Set up error messages or fallback actions if the API call fails.
  3. Save and Test: Save the form and test it by filling out the fields and triggering the API.

4. Integrating APIs in Workflows

Step 1: Add an API Step to a Workflow

  1. Open the "Workflows" section and edit the workflow where the API integration is required.
  2. Drag and drop an "API Call" action into the workflow diagram.

Step 2: Configure the API Step

  1. Select API: Choose the desired API from the pre-configured list.
  2. Trigger Conditions: Define the conditions under which the API should be triggered (e.g., after task completion, based on data input).
  3. Data Mapping: Map workflow data (e.g., variables, form data) to the API request parameters.

Step 3: Handle API Responses in Workflow

  1. Process Response Data: Define how the workflow should handle the API response (e.g., move to the next step, trigger another API call).
  2. Error Handling: Set up conditional logic to handle API errors (e.g., retry, send notification, log the error).
  3. Save and Test: Save the workflow and run a test to ensure the API step works as expected.

5. Using Out-of-the-Box Connectors

Step 1: Access the Connectors Library

  1. Go to the "APIs & Integrations" section.
  2. Select "Connectors" to view the list of available out-of-the-box connectors.

Step 2: Configure a Connector

  1. Select Connector: Choose the connector for the external system you wish to integrate with.
  2. Authentication Setup: Enter the required authentication details (e.g., API keys, credentials).
  3. Data Mapping: Map the application data to the fields required by the external system.

Step 3: Integrate the Connector into a Form or Workflow

  1. In Forms:
  2. Drag and drop the connector element into the form.
  3. Configure when and how the connector should be used (similar to API calls).
  4. In Workflows:
  5. Add the connector as a workflow step.
  6. Configure it like an API call, including data mapping and error handling.

6. Testing and Monitoring API Integrations

Step 1: Test API Integrations

  1. Use the "Test API" feature in both the API configuration and form/workflow editor.
  2. Monitor the API’s behavior by triggering it under various scenarios.

Step 2: Monitor API Usage and Performance

  1. API Logs: Access the "API Logs" to view the history of API calls, including successful requests and errors.
  2. Performance Metrics: Review response times, error rates, and data throughput to assess API performance.
  3. Alerts: Set up alerts for when an API call fails or takes too long to respond.

7. Best Practices for API Usage

  1. Rate Limits: Be mindful of the rate limits imposed by external APIs to avoid throttling or blocks.
  2. Error Handling: Implement robust error handling to manage failures gracefully.
  3. Security: Ensure all API communications are encrypted and use secure authentication methods.
  4. Documentation: Keep API documentation up-to-date for easier maintenance and troubleshooting.

API integration Summary

This manual has provided a comprehensive guide on how to configure and use APIs within the Low Code Platform. By following these instructions, you can enhance your applications with powerful integrations, automate workflows, and ensure seamless communication with external systems. Whether you are using custom APIs or out-of-the-box connectors, the platform’s flexible and user-friendly interface simplifies the entire process. The platform offers extensive API integration and connector capabilities, allowing seamless interaction with external systems: - REST & SOAP Support: Easily connect to RESTful and SOAP-based web services. - Pre-built Connectors: Access a library of connectors for popular services (e.g., CRM, ERP, databases, cloud storage). - Custom API Integration: Build custom connectors using the platform's API management tools. - Authentication Support: Handle different authentication methods (e.g., OAuth, API keys, Basic Auth). - Data Mapping: Map data fields between the application and external systems. - Event-Driven API Calls: Trigger API calls based on specific events or conditions within the application. - API Orchestration: Combine multiple API calls into a single workflow for complex integrations.