Skip to Content

Epay Connector

Summary

The Jitterbit Harmony Epay Connector establishes access to Epay.

The Epay connector provides an interface for creating an Epay connection, the foundation used for generating instances of Epay activities. These activities, once configured, interact with Epay through the connection.

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

Connector Overview

This connector is used to first configure an Epay connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Epay connection and its activities are referred to as an Epay endpoint:

Epay activity types

  • Read: Retrieves object data from Epay and is intended to be used as a source in an operation.

  • Update: Updates object data in Epay and is intended to be used as a target in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Epay connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

Epay's production environment (selected during connection configuration) has controlled security through allowlisting. To allow access to Epay's production environment while using this connector with a Private Agent, contact Epay and request the inclusion of your Private Agent IP addresses (located on the Management Console Agents page) in Epay's firewall allowlist. Jitterbit's Cloud Agents are already allowlisted with Epay.

The Epay connector uses the Epay REST API v1.

Troubleshooting

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

  1. Ensure the Epay 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 enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.epay" level="DEBUG"/>

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