Flex Connector Async API

Updated on 27 Dec 2023
2 Minutes to read

Print
Share
Dark
Light
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

This document describes the async API configuration options of the Flex Connector. In some API services, you will be required to use asynchronized API calls to generate the required result. Panoply's Flex Connector supports automation of this process by allowing you to trigger the async process, check its status and finally extract the required data.
First, you will need to enable the async API feature and configure the specific configurations based on the required API process.

When using the Async API feature, users might need to use the generated variables in the status check or main APIs configuration. The async identifier should be used in the async status check and the result identifier should be used in the main API. The variable name will be the same as the original identifier path from the previous response.
For example, if the async identifier is located in result.id, you will be able to use it in the async status check parameters like so export_id={result.id}. In this example, Panoply will use the value returned from the async trigger API (the result.id field) as a parameter value for the async statuc check API.

The async API feature is split to two groups. Each group has its own API configuration:

Async trigger:

URL - The equivalent of the Base URL. The API URL to trigger the async process
Method
POST data - Only available for POST method. Users can select between JSON or XML input.
JSON or XML - Depending on the selection of the above
URL parameters
Headers
Async identifier - The path to the async process identifier. The same path can be used in the async status check API. For example, If the path is process.identifier then the variable {process.identifier} will be available to use in the statu check API.
#### Async status check:
URL - The equivalent of the Base URL. The API URL to trigger the async process
Method
POST data - Only available for POST method.Users can select between JSON or XML input.
JSON or XML - Depending on the selection of the above
URL parameters
Headers
Repeat frequency - Define how many seconds the process should wait before rechecking the async process status.
Maximum iterations - Defined after how many iterations the job should fail, even if the async process is still running
Completion key - Path to the field in the response that indicates if the process completed successfully or not
Completion value - The value of the completion key that indicates successful completion. When encountering this value, the check iterations will stop and the main API will run
Failue value - The value of the completion key that indicates failed completion. When encountering this value, the job will fail.
Result identifier - The path to the result identifier. The same path can be used in the main API. For example, If the path is result.identifier then the variable {result.identifier} will be available to use in the main API configuration.

Was this article helpful?

What's Next

Flex Connector Release Notes