How to Integrate an API in VDesigner 2.0?

  1. Access the middleware of the application.
  2. Subscribe to an API from Vahana Hub and optionally test it.
  3. Change the service scope in VConnect to DEVICE LEVEL SESSION and synchronize changes via Release Manager.
  4. Create an entity in your CUG portal to store API output.
  5. Develop a Data Model for your application and then link your entity with your data model.
  6. And then, link your data model with your Application.
  7. Implement event triggers such as OnCompletion on the Input Field or OnClick on the button.
  8. Utilize the Configure Service task, accessing the API service created.
  9. Consume the API by selecting ADD OBJECT in the request parameters.
  10. Define input format and source element for request parameters.
  11. Specify the desired response structure and destination element for response parameters.
  12. Review and save the configuration.
  13. Apply, Save, Commit, and synchronize changes.

This refined process ensures smooth integration and effective utilization of APIs within VDesigner 2.0.

1 Like

Thanks Anushka.

Could you give us the step by step process for integrating API into Designer2

1 Like
  1. Navigate to the middleware of the application.
  2. Subscribe to an API via Vahana Hub.

  1. Optionally, test the API within Vahana Hub.
  2. Important Note: Change the scope of the service created in VConnect to DEVICE LEVEL SESSION.
    Here, We are transitioning the session to the Device Level because the user has already been authenticated by Vahana.

  1. Synchronize the changes from the Release Manager.
  2. Go to your CUG portal and create an entity.
  3. Store the output fetched by your API within the created entity.

  1. From Vahana Hub, you can copy the data for your entity.

Here from the Response section, you will get the Output for your Entity.

  1. Create a data model for your application.
  2. Now, Link your Entity with the data model.
  3. Link the data model with your application.

  1. Proceed with events such as OnCompletion for input fields or OnClick for buttons.
  2. Use these events to configure the service task.
  3. In the SET PARAMETERS section, select the API service you created.

  1. Consume the selected API service.
  2. Select ADD OBJECT in the request parameters.

  1. Provide the required format for the service input and specify the element from which the input should be fetched.

  1. In the Response Parameters section, specify the desired response from the API data and select the element for your output.

  1. Click on Review & Save.
  2. Click on Apply, Save, Commit, and synchronize the changes.