API Calls Builder | Vantage

Overview

The "API Calls Builder" page in Vantage serves as a dedicated interface for users to create and manage API calls within a data workflow. By leveraging the ApiBuilderClient component, this page allows users to build API requests seamlessly, integrating them into broader data workflows for analytics and processing tasks.

Purpose

The primary purpose of the API Calls Builder page is to facilitate the construction of API calls that can be utilized within Vantage workflows. This functionality is essential for users aiming to enhance their data processing capabilities by integrating third-party APIs or custom services.

How It Works

The API Calls Builder page operates by accepting a query parameter workflowId through searchParams. This ID is utilized to link the API calls to a specific workflow. The ApiBuilderClient component is the central element within this page, responsible for rendering the API call builder interface based on the provided workflowId.

1. Retrieve Workflow ID: The component retrieves the workflowId from the incoming searchParams.
2. Render API Builder Client: The ApiBuilderClient component is rendered with the workflowId to allow users to build their API requests contextual to that workflow.

Data Expectations

The primary data expected by the API Calls Builder page includes:

• workflowId: This is a string that uniquely identifies the workflow within which the API calls will be made. The page expects this parameter to exist; otherwise, the functionality may be limited or not usable.

Settings

API Builder Client Configuration

The ApiBuilderClient is an encapsulated component that takes specific props to function correctly, albeit the provided code does not explicitly outline these props. Nevertheless, the following settings would typically be included based on standard practices within such components:

1. Setting Name: workflowId
   • Input Type: String
   • What It Does: This setting links the API builder to a specific workflow. By changing it to a different workflow ID, the API builder will display the appropriate API calls and configurations related to that workflow.
   • Default Value: This typically might be null or undefined, as it requires a valid workflow ID to function.

Behavior Modifications

Changing the workflowId impacts:

• The APIs displayed and their configurations within the builder.
• The data context in which the built API calls will execute.

Since the provided code does not enumerate additional settings, details may vary based on implementation specifics found in the ApiBuilderClient.

Use Cases & Examples

Use Case 1: Third-Party Integration

A company wants to integrate a payment processing API into their user management workflow. They would use the API Calls Builder to define the API endpoints for processing payments and sending confirmation emails.

Use Case 2: Data Enrichment

Marketing teams often require additional data from external sources (e.g., social media analytics). By using the API Calls Builder, they can create calls to fetch this complementary data and enhance their customer profiles.

Use Case 3: Custom Notification System

A marketing organization needs to set up custom alerts for various events within their application workflows. The API Calls Builder would facilitate the creation of API calls to an internal notification service whenever a specified event occurs in the workflow.

Detailed Example Configuration

To address the third use case of a custom notification system, a sample configuration might look like this:

Workflow Specification

• Workflow ID: 12345

Sample API Call

{
  "apiEndpoint": "https://api.example.com/notify",
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": {
    "userId": "{{userId}}",
    "message": "A specified event has occurred in your workflow."
  }
}

How to Implement

1. Set the workflowId: Ensure the workflowId is set to 12345.
2. Access the API Calls Builder: Navigate to the API Calls Builder page to start building.
3. Input the API Configuration: Enter the endpoint, select the method, define headers, and specify the body.
4. Test the Call: Use the built-in testing functionality (if available) to validate the API call responses.

Through these detailed configurations and settings, the API Calls Builder is designed to offer robust functionality for users needing sophisticated API integration and data workflow management within Vantage.