API

The API Task allows integration and interaction with external services and systems through APIs, enabling Vahana vFlow 2.0 to exchange data and access functionalities beyond its native capabilities. This task is crucial for creating a connected application ecosystem, facilitating real-time data exchange and interoperability with various banking and financial services.

Common Uses:

1. Data Retrieval from External Systems:
   • For instance, fetching a customer’s banking transaction history from a core banking system or external service in real-time.
2. Pushing Data to an External Service:
   • Sending data such as user inputs, transaction details, or requests to an external API endpoint for processing or storage, like submitting a loan application.

Configuration

When you create a task, its configuration page opens in which you define its basic and advanced properties. These are as follows:

Basic

Basic Properties	Description
Task Type	The Task Type indicates what kind of task you are creating. This is a read-only field since you select the type when you create the task and cannot change it during the configuration stage.
Reference Name	The Reference Name acts as a unique internal identifier for the task. This is visible to vFlow users for ease of reference but is hidden from end users. This allows users of the platform to manage and differentiate between tasks conveniently.
Name	The name defined here will be displayed to the end user.
Description	The Description field is intended for use by application designers or administrators (vFlow users) to provide additional context or details about the task group. This description is not visible to end-users and is used solely for internal reference to assist with task management.
Loader Properties – Title
Loader Properties – Description
Business Rule – Rule	This drop-down allows you to specify a Business Rule that governs when and how this task executes, offering more fine-grained control over task execution. If the specified condition is met, the task will execute; otherwise, it will not.

Properties

Type: From the dropdown list, select the type from Online and API.

Service Name: Select the service name according to the type you select.

• Scenario 1: If you select the type as ONLINE
  • Service Names: AUTH, PROPERTYMASTER, PWSYNCCONFIG, SPTBGETCOMPONENTCFG, SPTBGETCOMPONENTVERSION, SPTBGETCONFIGVERSION, and more.
  • Request:
    • Key: In this field, enter the request type key or parameter (for example:- proposalId).
    • Type: Select from Fixed or JSON Key-value type.
      • Fixed: Select this option to store the value in the key in string format.
      • JSON: Select this option to store the value in the key in JSON format.
    • Value:
    • Cast To JSON: Select it, if you want the value should be cast to JSON format.
  • Response:
    • Key: In this field, enter the response type key as follows:
      
      # Sample Key Name: getVal(“tempObject.retrigger.result”).
      
      When the API task is executed, the API returns the response and then stores it in the result key in the retrigger object
    • Type: Select from Fixed or JSON Key-value type.
      • Fixed: Select this option to store the value in the key in string format.
      • JSON: Select this option to store the value in the key in JSON format.
    • Value: Define the response value as needed.

• Scenario 2: If you select the type as API
  • Select the service name accordingly.

Run on Background:

• Allows the API to execute in the background.

Run as Asynchronous:

• Enables asynchronous execution for improved application performance and responsiveness.