Skip to Content

API Connector

Summary

The Jitterbit Harmony API Connector has a preconfigured connection that provides access to API activities. These activities, once configured, interact with Custom APIs configured in Jitterbit Harmony API Manager.

This connector has a preconfigured connection and does not require connection configuration as is typical for most Jitterbit Harmony connectors.

Important

By default, successful API operations (configured for Custom APIs or OData Services) are not included in the operation logs unless one of these settings is enabled:

  • Cloud Agents: For API operations on a Cloud Agent, operation debug logging must be enabled on the operation.
  • Private Agents: For API operations on a Private Agent, either operation debug logging must be enabled on the operation or you must set EnableLogging=true in the [APIOperation] section of the Private Agent configuration file.

    • The API connector is accessed from the design component palette's Connections tab (see Design Component Palette).

    Connector Overview

    This connector is intended to be used in conjunction with an API Manager Custom API to expose an operation or a set of operations as a consumable REST endpoint.

    Activity types are used to create instances of activities that are intended to be used as sources (providing data) or targets (receiving data) in an operation.

    Together, the preconfigured API connection and its activities are referred to as an API endpoint:

    API activity types

    • Request: Configured using a JSON, XML, CSV, or XSD schema, this activity retrieves data when called by an API Manager Custom API and is intended to be used as a source to provide data to an operation.

    • Response: Configured using a JSON, XML, CSV, or XSD schema, this activity returns data to an API Manager Custom API and is intended to be used as a target to consume data in an operation.

    • SOAP Request: Configured using a WSDL schema, this activity retrieves data when called by an API Manager Custom API and is intended to be used as a source to provide data to an operation.

    • SOAP Response: Configured using a WSDL schema, this activity returns data to an API Manager Custom API and is intended to be used as a target to consume data in an operation.

    API Jitterbit Variables

    These Jitterbit variables are provided specifically for use with API endpoints:

    Troubleshooting

    If you experience issues with the API connector, these troubleshooting steps are recommended:

    1. Ensure the API connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

    2. Check the operation logs for any information written during execution of the operation.

    3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

    4. If using Private Agents, you can check the agent logs for more information.

    Reference

    For information on the relationship between API connector activities and API Manager APIs, see these resources: