Learn how to integrate external APIs with ease using the API Call feature. Configure HTTP methods, URLs, headers, authentication, and more with detailed instructions.
Last updated
The API Call feature facilitates the integration of external APIs into the system by allowing users to make HTTP requests to specified URLs. This documentation provides detailed instructions on configuring API calls within the system.
HTTP Method: Specifies the HTTP method to be used for the API call, such as GET, POST, PUT, or DELETE.
URL: The endpoint URL to which the API call will be made.
Headers: Additional information included in the request headers, such as content type, authorization, or custom headers.
Authentication: Specifies the authentication method required for accessing the API, such as API keys, OAuth tokens, or basic authentication.
Select Connection: Allows users to choose from pre-configured connections or set up new connections to external systems.
Query Parameters: Optional parameters included in the API call URL to customize the request.
Body Content Type: Specifies the format of the request body content, such as JSON, XML, or form-URL encoded.
Body: The payload or data to be sent in the request body, if applicable.
Test Values: Allows users to input test values for the API call to simulate and validate the request.
Response from API: Displays the response received from the API after making the request, including status code, headers, and body content.
Store Response in Variables: Provides the option to store specific values from the API response in variables for further processing or use in subsequent actions.
Configure API Call: Input the necessary details such as HTTP method, URL, headers, authentication, and other parameters.
Test API Call: Use test values to simulate the API call and verify the response received from the API.
Store Response Data: Select specific data elements from the API response to store in variables for use in subsequent actions or processes.
Ensure accurate configuration of HTTP method, URL, headers, and authentication credentials.
Validate API responses and handle errors gracefully to maintain system stability.
Use descriptive reference IDs and comments to document the purpose and context of each API call.
The API Call feature offers users a powerful tool for integrating external APIs seamlessly into the system. By following the guidelines provided, users can configure and execute API calls effectively, retrieve relevant data, and leverage it for various system functionalities.
