This connector should be used in conjunction with a Jitterbit Custom API that is configured from the Harmony API Manager. This type of connector exposes an operation or set of operations as a consumable REST endpoint. When an operation is triggered by a Jitterbit Custom API, you might need to receive data from or return data to the calling application.
The API connector is accessed from the Connectivity tab of the design component palette:
This connector has a preconfigured API connection that is used to configure one or more API activities associated with that connection as a source or target within an operation:
|NOTE: The fact that the API connection is a preconfigured endpoint makes this connector unique compared with other connector types. The typical setup for other endpoints is to first use a connector to configure a connection.|
Together, a specific API connection and its activities are referred to as an API endpoint. Activities associated with the endpoint are available from the Endpoints filter:
Certain Jitterbit variables are provided specifically for use with Jitterbit Custom API endpoints, including:
For details on using these variables, see API Jitterbit Variables.